summaryrefslogtreecommitdiff
path: root/js/README.md
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2014-11-04 21:10:04 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2014-11-04 21:10:17 -0800
commiteb0576780eff57422e4d50a8aacfb1514e4299cd (patch)
treeb26385a23805e62a067e7b18608e775d8912af4b /js/README.md
parent7a787c37694cd90e71b75f7eb4405fcc83b1fc70 (diff)
Added packaging for npm module 'commonmark'.
Published to npm. Closes #21. The 'stmd' package should be deprecated.
Diffstat (limited to 'js/README.md')
-rw-r--r--js/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/js/README.md b/js/README.md
new file mode 100644
index 0000000..9f1e043
--- /dev/null
+++ b/js/README.md
@@ -0,0 +1,24 @@
+CommonMark
+==========
+
+CommonMark is a rationalized version of Markdown syntax,
+with a [spec][the spec] and BSD3-licensed reference
+implementations in C and JavaScript.
+
+For more information, see <http://commonmark.org>.
+
+To play with this library without installing it, see
+the live dingus at <http://spec.commonmark.org/dingus.html>.
+
+This package includes the commonmark library and a
+command-line executable, `commonmark`.
+
+Basic usage example:
+
+ var reader = new commonmark.DocParser();
+ var writer = new commonmark.HtmlRenderer();
+ var parsed = reader.parse("Hello *world*");
+ var result = writer.render(parsed);
+
+ [the spec]: http://spec.commonmark.org
+