diff --git a/README.mkd b/README.mkd new file mode 100644 index 0000000..6d025d8 --- /dev/null +++ b/README.mkd @@ -0,0 +1,41 @@ +# CML To HTML Converter + +## What is CML? +Check out [the spec!](http://contextual-markup-language.org/) + +## What does this library do? +This NPM library is just a single function that implements the CML spec by converting a string of CML into HTML. + +## How do I use it? +- Install it using NPM: `npm install cml-html-converter` +- require it the module, then call it. +```javascript + var exampleCMLString = + 'item one of root list\n' + + '\titem one of 1st nested list\n' + + '\t\titem one of 2nd nested list\n' + + '\titem two of 1st nested list' + var converter = require('cml-html-converter'); + var htmlString = converter(exampleCMLString); +``` +- in the example above `htmlString` should look something like this: +```html + +```