Skip to content

Commit bc52bc7

Browse files
committed
Improved README with note on wrappers.
1 parent 63a4d26 commit bc52bc7

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,18 @@ implementations in C and JavaScript.
1010
For more information, see <http://commonmark.org>.
1111

1212
This repository contains the C reference implementation.
13-
It provides a library with functions for parsing CommonMark
14-
documents to an abstract syntax tree (AST), manipulating the AST,
15-
and rendering the document to HTML or to an XML representation of the
16-
AST. It also provides a command-line program, `cmark`, for
17-
parsing and rendering CommonMark documents.
18-
19-
The library is fast, on par with [sundown]: see the [benchmarks].
13+
It provides a shared library (`libcmark`) with functions for parsing
14+
CommonMark documents to an abstract syntax tree (AST), manipulating
15+
the AST, and rendering the document to HTML or to an XML
16+
representation of the AST. It also provides a command-line program
17+
(`cmark`) for parsing and rendering CommonMark documents.
18+
19+
The library and program are written in standard C99 and have
20+
no library dependencies. The parser is very fast, on par with
21+
[sundown]: see the [benchmarks].
22+
23+
It is easy to use `libcmark` in python, lua, ruby, and other dynamic
24+
languages: see the `wrappers/` subdirectory for some simple examples.
2025

2126
[sundown]: https://github.com/vmg/sundown
2227
[benchmarks]: benchmarks.md

0 commit comments

Comments
 (0)