Skip to content

Commit

Permalink
Improved README with note on wrappers.
Browse files Browse the repository at this point in the history
  • Loading branch information
jgm committed Jan 25, 2015
1 parent 63a4d26 commit bc52bc7
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,18 @@ implementations in C and JavaScript.
For more information, see <http://commonmark.org>.

This repository contains the C reference implementation.
It provides a library with functions for parsing CommonMark
documents to an abstract syntax tree (AST), manipulating the AST,
and rendering the document to HTML or to an XML representation of the
AST. It also provides a command-line program, `cmark`, for
parsing and rendering CommonMark documents.

The library is fast, on par with [sundown]: see the [benchmarks].
It provides a shared library (`libcmark`) with functions for parsing
CommonMark documents to an abstract syntax tree (AST), manipulating
the AST, and rendering the document to HTML or to an XML
representation of the AST. It also provides a command-line program
(`cmark`) for parsing and rendering CommonMark documents.

The library and program are written in standard C99 and have
no library dependencies. The parser is very fast, on par with
[sundown]: see the [benchmarks].

It is easy to use `libcmark` in python, lua, ruby, and other dynamic
languages: see the `wrappers/` subdirectory for some simple examples.

[sundown]: https://github.com/vmg/sundown
[benchmarks]: benchmarks.md
Expand Down

0 comments on commit bc52bc7

Please sign in to comment.