Permalink
Browse files

changing readme.MD

  • Loading branch information...
1 parent 348fae9 commit 86e2591aa1f0e106b5f0a55bf8c11f5b6079cafa @mariuskubilius committed Jul 8, 2013
Showing with 9 additions and 7 deletions.
  1. +9 −7 readme.md
View
16 readme.md
@@ -1,19 +1,21 @@
# lbg-mongoose-utils #
A small collection of mongoose extensions to be used in my projects.
# Current modules: #
-## slugify ##
+## slugify ##
creates unique slugs for assigned items.
-## ancestorTree ##
+## ancestorTree ##
helps maintaining hierarchical items.
use array of ancestors pattern can be seen here:
http://docs.mongodb.org/manual/tutorial/model-tree-structures-with-ancestors-array/
## status ##
-adds status field and adds static methods:
- * publishDocument,
- * unPublishDocument
- * trashDocument.
-### usage of status module: ###
+adds status field and adds static methods:
+
+* publishDocument,
+* unPublishDocument
+* trashDocument.
+
+### usage of status module: ###
model.publishDocument(id, function(err, result) {
console.log(result)
});

0 comments on commit 86e2591

Please sign in to comment.