Permalink
Browse files

Some README fixes

  • Loading branch information...
1 parent 3f9a0d7 commit c5c458aeb726830d5c435081b86492a5d7cb7f19 @rauchg rauchg committed Sep 25, 2010
Showing with 35 additions and 1 deletion.
  1. +35 −1 README.md
View
36 README.md
@@ -80,10 +80,15 @@ Building on top of the powerful jade template engine filters, nodestream solves
The `:realtime` filter takes the following options
`local`: The local variable passed to your template that your piece of html interacts with
+
`obj`: Required for `append`, the name of the local used when the collection is looped through.
+
`append`: Append event
+
`repaint`: Repaint event name. If it finished on `.`, the `id` property is appended to it for every item on a collection (dynamic event name)
+
`remove`: Remove event name. If it finished on `.`, the `id` property is appended to it for every item on a collection (dynamic event name)
+
`id`: The name of the key to look for an unique identifier to append to events finished in `.`
### Example
@@ -110,4 +115,33 @@ On the client side:
- if (connections > 1)
p #{connections} people are editing right now
- else
- p You're all alone, loser
+ p You're all alone, loser
+
+### Credits
+
+Guillermo Rauch <guillermo@learnboost.com> ([guille](http://github.com/guille))
+
+### License
+
+(The MIT License)
+
+Copyright (c) 2010 LearnBoost <dev@learnboost.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 comments on commit c5c458a

Please sign in to comment.