Skip to content

Commit

Permalink
Added installation intructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jason490 authored Nov 28, 2023
1 parent 2e76530 commit 2d8bcc3
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,25 @@ To report issues for Submitty/Markdown, please file them under the [Submitty/Sub
- Apply league/commonmark as an Twig Extension

## Installation
In progress
```json
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/Submitty/Markdown.git"
}
],
"require":{
"league/commonmark": "2.4.0",
"submitty/markdown": "version"
}
}
```
```bash
composer install
# or
composer update
```

## Example
```php
Expand All @@ -34,9 +52,4 @@ twig->addExtension(new MarkdownExtension($engine));

## See Documentation
Documentation in Progress

[Developing]()

[Usages]()

[General Documentation](submitty.org)

0 comments on commit 2d8bcc3

Please sign in to comment.