From de20a98b7768a37be0f75f1f62773f8e1e715f98 Mon Sep 17 00:00:00 2001
From: Cory Forsyth <cory.forsyth@gmail.com>
Date: Thu, 9 Jul 2015 12:20:17 -0400
Subject: [PATCH] add readme

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f0fde6c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Mobiledoc DOM Renderer
+
+This is a runtime renderer for the `mobiledoc` format.
+It renders mobiledoc to DOM elements.
+
+It is intended to be a small libraray that is run client-side in a browser that wants to display mobiledoc.
+
+## Usage
+
+```
+var mobiledoc = [
+  [         // markers
+    ['B']
+  ],
+  [         // sections
+    [1, 'P', [ // array of markups
+      // markup
+      [
+        [0],          // open markers (by index)
+        0,            // close count
+        'hello world'
+      ]
+    ]
+  ]
+];
+var renderer = new DOMRenderer();
+var rendered = renderer.render(mobiledoc);
+document.getElementById('output').appendChild(rendered);
+// renders <div><p><b>hello world</b></b></div>
+// into 'output' element
+```
+
+## Tests
+
+ * `npm test`