From ccdb76c7e3ac7d18b2ef4af55d0ac9ccf59d2498 Mon Sep 17 00:00:00 2001 From: sandypockets Date: Sat, 16 Dec 2023 22:40:42 -0500 Subject: [PATCH] Fix: Add missing contributing, license info --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2fd0117..c8ed9fb 100644 --- a/README.md +++ b/README.md @@ -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` @@ -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) \ No newline at end of file +`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. \ No newline at end of file