Permalink
Browse files

fix up the readme, add toString

  • Loading branch information...
1 parent da8c6ad commit 1369f2a3e9025756873d2e552b7818bd2337b1a3 @tblobaum committed Aug 9, 2012
Showing with 13 additions and 4 deletions.
  1. +13 −4 README.md
View
@@ -103,12 +103,12 @@ return a union of the edges with the `nodes` edges provided with logical `||`
``` js
Node('you').membership.union('me', function (e, nodes) {
- // do something with the list of memberships either `'you'` || `'me'` have
+ // do something with the list of memberships either 'you' || 'me' have
// ..
})
Node('user').members.union('admin', function (e, nodes) {
- // do something with the members of `'user'` and `'admin'`
+ // do something with the members of 'user' and 'admin'
// ..
})
```
@@ -118,7 +118,7 @@ return an intersection of the edges with the `nodes` edges provided, with logica
``` js
Node('you').membership.intersect('me', function (e, nodes) {
- // do something with the list of memberships both `'you'` && `'me'` have
+ // do something with the list of memberships both 'you' && 'me' have
// ..
})
```
@@ -128,7 +128,7 @@ return the result of a subtraction of the `nodes` edges from the instance's edge
``` js
Node('you').membership.without('me', function (e, nodes) {
- // do something with the list of memberships `'you'` have that `'me'` does not have
+ // do something with the list of memberships 'you' have that 'me' does not have
// ..
})
```
@@ -148,6 +148,15 @@ Node('you').membership.members(function (e, nodes) {
})
```
+## .toString(function (error) { ... })
+return the string id of this instance
+
+``` js
+Node('user').toString()
+// => 'user'
+
+```
+
## .delete(function (error) { ... })
delete this instance and remove all of its edges from redis

0 comments on commit 1369f2a

Please sign in to comment.