Merge pull request #8 from dominictarr/master

add a quick example
This commit is contained in:
Corey Innis 2012-05-27 15:05:18 -07:00
commit de9ffb444f

View File

@ -33,6 +33,19 @@ Redistributable under a BSD-style open source license.
See license.txt for more information.
Quick Example
-------------
``` js
var Showdown = require('showdown').Showdown
var converter = new Showdown().converter()
converter.makeHtml('#hello markdown!')
// <h1 id='<h1 id="hellomarkdown">hello, markdown</h1>
```
What's it for?
--------------