Permalink
Browse files

Updated README

  • Loading branch information...
1 parent 6be311f commit f0fcc6827559499f4426adc6ef83dd9b82075ff8 @chriso committed May 11, 2011
Showing with 9 additions and 7 deletions.
  1. +7 −5 README.md
  2. +2 −2 site/index.html
View
@@ -17,7 +17,7 @@ Redback provides an accessible and extensible interface to the Redis [data types
It also comes with the following more advanced data structures:
-- **DensitySet** - A sorted set where adding an element increments its score, and removing decrements it.
+- **DensitySet** - A sorted set where adding an element increments its score and removing it decrements it.
- **KeyPair** - Uses two hash structures and an auto-incrementing key to assign an ID to each unique value
- **SocialGraph** - Similar to Twitter's (following vs. followers)
- **CappedList** - A list with a fixed length
@@ -40,10 +40,7 @@ It also comes with the following more advanced data structures:
## Creating your own structures
To create your own structure, use `addStructure(name, methods)`.
-Structures have access to a Redis key `this.key` and the Redis client
-`this.client`. If an `init()` method is defined, then it is called after
-the structure is instantiated - `init()` receives an extra parameters
-when calling `create<structure>()`
+
Let's create a queue that can be either FIFO or LIFO
@@ -65,6 +62,11 @@ To use the queue, call `createQueue(key, is_fifo)`
var queue = redback.createQueue('my_queue', true);
queue.add('awesome!', callback);
+Structures have access to a Redis key `this.key` and the Redis client
+`this.client`. If an `init()` method is defined, then it is called after
+the structure is instantiated. Also note that `init()` receives any extra parameters
+when calling `create<structure>()`.
+
## Other uses
**Cache backend**
View
@@ -196,10 +196,10 @@
<a class="hint" href="https://github.com/chriso/redback/wiki/Node.JS-and-NPM">Don't have NPM or Node.JS?</a>
<h2>Learn more</h2>
- <p>See <a href="https://github.com/chriso/redback/wiki">the wiki</a> for documentation and examples, or click below to visit the GitHub repository.</p>
+ <p>See the <a href="https://github.com/chriso/redback">GitHub repository</a> for more information. For an API, see the <a href="http://redbackjs.com/api.html">annotated source</a>.</p>
<button class="first" onclick="location.href='https://github.com/chriso/redback';">Source</button>
- <button onclick="location.href='https://github.com/chriso/redback/wiki';">Documentation</button>
+ <button onclick="location.href='https://github.com/chriso/redback/wiki';">Wiki</button>
</div>

0 comments on commit f0fcc68

Please sign in to comment.