Przeglądaj źródła

add quick example

Dominic Tarr 14 lat temu
rodzic
commit
11fc69fe9f
1 zmienionych plików z 13 dodań i 0 usunięć
  1. 13 0
      README.md

+ 13 - 0
README.md

@@ -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?
 --------------