Skip to content

Commit

Permalink
Fix: Add missing contributing, license info
Browse files Browse the repository at this point in the history
  • Loading branch information
sandypockets committed Dec 17, 2023
1 parent 41cc43d commit ccdb76c
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Use the all-in-one `processMarkdown` function to format your markdown into HTML,
* Next.js
* Nuxt.js

All supported frameworks are available in the `examples/` directory. You can still use `epic-remark` with other frameworks, but you'll need to sort out the build and integration yourself.

### Dependencies
- `remark`: `^15.0.1`
- `remark-gfm`: `^4.0.0`
Expand Down Expand Up @@ -44,7 +46,12 @@ Estimates the reading time of the provided markdown content. The calculation is
Embeds content from external sources, such as YouTube videos and GitHub gists with simple syntax like `!embed https://your-embed-url.com/`

### Notes
Processed markdown always returns auto-linked URLs. This means that if you have a URL in your markdown, it will be converted to a clickable link.
Processed markdown always returns auto-linked URLs. This means that if you have a URL in your markdown, it will be converted to a clickable link.

## Contributing
Contributions are welcome! Please see the contributing docs for more details.

## License
MIT. See [license.md](LICENSE.md)
`epic-remark` uses the MIT license. See [license.md](LICENSE.md) for more details.

`epic-remark` also depends on several other packages, all of which except for `yaml` (which is ISC) are also MIT license.

0 comments on commit ccdb76c

Please sign in to comment.