Skip to content

Commit

Permalink
Chore: Add warning
Browse files Browse the repository at this point in the history
  • Loading branch information
sandypockets committed Dec 16, 2023
1 parent 3187994 commit 703abe4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# `epic-remark`

**Warning**: This package is still in development. It is not yet ready for production use.

`epic-remark` is a Markdown to HTML processor built on top of `remark`. It adds GitHub-flavoured markdown capabilities, alongside some handy must-have custom plugins.

Use the all-in-one `processMarkdown` function to format your markdown into HTML, or import the custom plugins working behind the scenes one-by-one to mix your own flavour of Markdown HTML.

## Currently supported frameworks:
* Next.js

### Dependencies
- `remark`: `^15.0.1`
- `remark-gfm`: `^4.0.0`
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "epic-remark",
"version": "0.1.4",
"version": "0.1.5",
"description": "Epic Remark is an all-in-one markdown to HTML processor built on top of remark",
"main": "dist/index.js",
"module": "dist/index.esm.js",
Expand Down

0 comments on commit 703abe4

Please sign in to comment.