summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2015-01-24 21:47:46 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2015-01-24 21:47:46 -0800
commitbc52bc756aaaa20d20d76dc2bc0f721f2801f9bb (patch)
tree99794c27e7a1d92e422b9a023d43cd6aa244a542 /README.md
parent63a4d269c56dfade77f9c51899b776b3d69bc66e (diff)
Improved README with note on wrappers.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 12 insertions, 7 deletions
diff --git a/README.md b/README.md
index 750e56a..61df752 100644
--- a/README.md
+++ b/README.md
@@ -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