Skip to content
Browse files

Doc updates/improvements

  • Loading branch information...
1 parent 6c80c22 commit 3af24003b60eaab8fcdc96789dbd6f8209dfda23 @luccastera luccastera committed
Showing with 8 additions and 0 deletions.
  1. +8 −0 README.md
View
8 README.md
@@ -21,6 +21,13 @@ UserSchema.plugin(NestedSetPlugin);
var User = mongoose.model('User', UserSchema);
```
+### Attributes
+
+The plugin adds the following attributes to the model:
+* lft: holds the left value of the node in the tree
+* rgt: holds the right value of the node in the tree
+* parentId: holds the _id of the parent node
+
### Examples
Examples are based on the following tree:
@@ -87,6 +94,7 @@ The following methods must be used with a callback. The callback method will be
### Related Links/Resources
+* Inspired by [Rails nested_set library] (https://github.com/skyeagle/nested_set)
* [Mongoose Documentation] (http://mongoosejs.com/)
* [Mongoose Plugins] (http://mongoosejs.com/docs/plugins.html)
* [Tree used in test and examples] (https://github.com/groupdock/mongoose-nested-set/raw/master/docs/test_tree.png)

0 comments on commit 3af2400

Please sign in to comment.
Something went wrong with that request. Please try again.