Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added ./docs

  • Loading branch information...
commit 948f6a2a1d7d6bc29fe3f41b06cd9bea5c0643d5 1 parent e39a162
@tj tj authored
Showing with 29 additions and 0 deletions.
  1. +29 −0 docs/index.rst
View
29 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>
Please sign in to comment.
Something went wrong with that request. Please try again.