diff --git a/.gitignore b/.gitignore index 6e625f3..5715210 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ *travis.log -.vscode \ No newline at end of file +.vscode +necmark.zip \ No newline at end of file diff --git a/README.md b/README.md index 98912ab..5f43a4e 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,19 @@ necmark is a haxe/neko library that wraps subset of cmark C library (that is one - supported options: ``CMARK_OPT_UNSAFE``, ``CMARK_OPT_NOBREAKS``, ``CMARK_OPT_HARDBREAKS``, ``CMARK_OPT_SOURCEPOS``, ``CMARK_OPT_SMART`` - safe HTML output is on by default (like in ``libcmark``) + +## Installation + + haxelib install necmark +or + + haxelib git https://github.com/ConstNW/necmark + +### Usage + +```haxe +var n = new necmark.Necmark("Hello World!"); +n.render(ncrHtml(necmark.Necmark.RENDER_OPT_UNSAFE)); +``` + +[more examples](https://github.com/ConstNW/necmark/tree/master/test)