Permalink
Browse files

document widget

  • Loading branch information...
1 parent 44d2ee0 commit c712e99d192c0676f55e5cd17a61d0aa7b4225a8 @dominictarr committed Jan 12, 2013
Showing with 14 additions and 0 deletions.
  1. +14 −0 README.md
View
@@ -41,6 +41,20 @@ shoe(function (stream) {
}).install(httpServer)
```
+## widget
+
+Create a widget that displays text as a subset of markdown.
+
+``` js
+var widget = require('r-edit/widget')
+var e = new REdit()
+
+document.body.appendChild(widget(e))
+```
+
+So far, only a few features are supported, headers, italics, bold, code, and bullet-points.
+but not syntax that must go over multiple lines, such as quotes, large code sections, or nested lists.
+
## License
MIT

0 comments on commit c712e99

Please sign in to comment.