Added ./docs

visionmedia · Jul 20, 2011 · 948f6a2 · 948f6a2
1 parent e39a162
commit 948f6a2
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,29 @@
+Express Messages
+----------------
+
+The ``express-messages`` module provides flash notification rendering. To use simply assign it to a dynamic helper:
+
+    app.dynamicHelpers({ messages: require('express-messages') });
+
+Installation
+-------------
+
+    $ npm instal express-messages
+
+## Usage
+
+Then in a view you may output the notifications:
+
+    <%- messages() %>
+
+Which outputs HTML as shown below:
+
+    <div id="messages">
+      <ul class="info">
+        <li>Email queued</li>
+        <li>Email sent</li>
+      </ul>
+      <ul class="error">
+        <li>Email delivery failed</li>
+      </ul>
+    </div>