summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2014-11-12 10:48:30 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2014-11-12 10:48:30 -0800
commitf706feb47054f594bb4585558268264ae7b4346e (patch)
tree4fed885fbba5b2e32496313fa4ba260c6c5677b6 /README.md
parent4127d33b392fbfc96a049e93ec4041ec8d59c15a (diff)
Added note on using the library from python or ruby.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 10 insertions, 8 deletions
diff --git a/README.md b/README.md
index 2577bb5..501d6bc 100644
--- a/README.md
+++ b/README.md
@@ -10,14 +10,14 @@ implementations in C and JavaScript.
The implementations
-------------------
-The C implementation provides both a library and a standalone program
-`cmark` that converts CommonMark to HTML. It is written in standard C99
-and has no library dependencies. The parser is very fast, on par with
-[sundown](https://github.com/vmg/sundown). Some benchmarks (on
-an ancient Thinkpad running Intel Core 2 Duo at 2GHz, measured using
-`time` and parsing a ~500K book, the English version of [*Pro
-Git*](https://github.com/progit/progit/tree/master/en) by
-Scott Chacon and Ben Straub):
+The C implementation provides both a shared library (`libcmark`) and a
+standalone program `cmark` that converts CommonMark to HTML. It is
+written in standard C99 and has no library dependencies. The parser is
+very fast, on par with [sundown](https://github.com/vmg/sundown). Some
+benchmarks (on an ancient Thinkpad running Intel Core 2 Duo at 2GHz,
+measured using `time` and parsing a ~500K book, the English version of
+[*Pro Git*](https://github.com/progit/progit/tree/master/en) by Scott
+Chacon and Ben Straub):
|Implementation | Time | Factor|
|---------------|-------|--------|
@@ -30,6 +30,8 @@ Scott Chacon and Ben Straub):
| **cmark** | 0.020s| 1.1|
| sundown | 0.018s| 1.0|
+It is easy to use `libcmark` in python or ruby code: see `wrapper.py`
+and `wrapper.rb` in the repository for simple examples.
The JavaScript implementation is a single JavaScript file, with
no dependencies, that can be linked to in an HTML page. Here