updated readme

Author: swayf

README.md

@@ -1,12 +1,22 @@
-## mongoose-tree
+## mongoose-path-tree
 
-Implements the materialized path strategy for storing a hierarchy of documents with mongoose
+Implements the materialized path strategy with cascade child re-parenting on delete for storing a hierarchy of documents with mongoose
+Version with all collected features and fixes from mongoose-tree, mongoose-tree-fix, mongoose-tree2, mongoose-reparenting-tree
 
 # Usage
 
 Install via NPM
 
-    $ npm install mongoose-tree
+    $ npm install mongoose-path-tree
+
+## Options
+
+```javascript
+Model.plugin(tree, {
+  pathSeparator : '#' // Default path separator
+  onDelete :  'REPARENT' // Can be set to 'DELETE' or 'REPARENT'. Default: 'REPARENT'
+})
+```
 
 Then you can use the plugin on your schemas
 
@@ -56,14 +66,6 @@ At this point in mongoDB you will have documents similar to
 
 The path is used for recursive methods and is kept up to date by the plugin if the parent is changed
 
-## Options
-
-```javascript
-Model.plugin(tree, {
-  pathSeparator : '#' // Default path separator
-})
-```
-
 # API
 
 ### getChildren
@@ -72,7 +74,7 @@ Signature:
 
     getChildren([recursive], cb);
 
-if recursive is supplied and true subchildren are returned
+if recursive is supplied and true, subchildren are returned
 
 Based on the above hierarchy:
 
@@ -86,6 +88,79 @@ adam.getChildren(true, function(err, users) {
 });
 ```
 
+### getChildrenTree
+
+Signature:
+   
+    getChildrenTree([args], cb);
+
+return a recursive tree of subchildren.
+
+args is an object you can defined with theses properties :
+
+    filters: mongoose query filter, optional, default null
+      example: filters: {owner:myId}
+
+    fields: mongoose fields, optional, default null (all columns)
+      example: columns: {"_id name owner"}
+
+    options: mongoose query option, optional, default null
+      example: options:{{sort:'-name'}}
+
+    minLevel: level at which will start the search, default 1
+      example: minLevel:2
+
+    recursive: boolean, default true
+      make the search recursive or only fetch childs for the specified level
+      example: recursive:false
+
+    allowEmptyChildren: boolean, default true
+      if true, every childs not having subchilds will have childs attribute (empty array)
+      if false, every childs not having subchilds will not have childs attribute
+
+    Example :
+
+    ```javascript
+    var args = {
+      filters: {owner:myId},
+      columns: {"_id name owner"},
+      minLevel:2,
+      recursive:true,
+      emptyChilds:false
+    }
+
+    getChildren(args,myCallback);
+    ```
+
+Based on the above hierarchy:
+
+```javascript
+adam.getChildren([function](err, users) {
+
+    /* if you dump users, you will have something like this :
+    {
+      "_id" : ObjectId("50136e40c78c4b9403000001"),
+      "name" : "Adam",
+      "path" : "50136e40c78c4b9403000001"
+      "childs" : [{
+          "_id" : ObjectId("50136e40c78c4b9403000002"),
+          "name" : "Bob",
+          "parent" : ObjectId("50136e40c78c4b9403000001"),
+          "path" : "50136e40c78c4b9403000001.50136e40c78c4b9403000002"
+          "childs" : [{
+              "_id" : ObjectId("50136e40c78c4b9403000003"),
+              "name" : "Carol",
+              "parent" : ObjectId("50136e40c78c4b9403000002"),
+              "path" : "50136e40c78c4b9403000001.50136e40c78c4b9403000002.50136e40c78c4b9403000003"
+          }]
+      }]
+    }
+    */
+
+});
+
+```
+
 ### getAncestors
 
 Signature:

package.json

@@ -15,7 +15,7 @@
         "url": "git://github.com/swayf/mongoose-path-tree.git"
     },
     "main": "index.js",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "engine": "node >= 0.4.0",
     "dependencies": {
         "mongoose": "3.x.x"