Skip to content

Commit fce83d6

Browse files
committed
release 0.0.1
1 parent 2692657 commit fce83d6

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
*travis.log
2-
.vscode
2+
.vscode
3+
necmark.zip

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,19 @@ necmark is a haxe/neko library that wraps subset of cmark C library (that is one
1111
- supported options: ``CMARK_OPT_UNSAFE``, ``CMARK_OPT_NOBREAKS``,
1212
``CMARK_OPT_HARDBREAKS``, ``CMARK_OPT_SOURCEPOS``, ``CMARK_OPT_SMART``
1313
- safe HTML output is on by default (like in ``libcmark``)
14+
15+
## Installation
16+
17+
haxelib install necmark
18+
or
19+
20+
haxelib git https://github.com/ConstNW/necmark
21+
22+
### Usage
23+
24+
```haxe
25+
var n = new necmark.Necmark("Hello World!");
26+
n.render(ncrHtml(necmark.Necmark.RENDER_OPT_UNSAFE));
27+
```
28+
29+
[more examples](https://github.com/ConstNW/necmark/tree/master/test)

0 commit comments

Comments
 (0)