From eb0576780eff57422e4d50a8aacfb1514e4299cd Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Tue, 4 Nov 2014 21:10:04 -0800 Subject: Added packaging for npm module 'commonmark'. Published to npm. Closes #21. The 'stmd' package should be deprecated. --- js/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 js/README.md (limited to 'js/README.md') 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 . + +To play with this library without installing it, see +the live dingus at . + +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 + -- cgit v1.2.3