release 0.0.1

ConstNW · Jun 10, 2019 · fce83d6 · fce83d6
1 parent 2692657
commit fce83d6
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 *travis.log
-.vscode
+.vscode
+necmark.zip
diff --git 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)