Permalink
Browse files

changing readme to reflect changes.

  • Loading branch information...
1 parent 10b5a3f commit 348fae9611754e179e629826c673f14622847647 @mariuskubilius committed Jul 8, 2013
Showing with 18 additions and 3 deletions.
  1. +18 −3 readme.md
View
@@ -1,6 +1,21 @@
+# lbg-mongoose-utils #
A small collection of mongoose extensions to be used in my projects.
-Current modules:
-slugify - creates unique slugs for assigned items.
-ancestorTree - helps maintaining hierarchical items.
+# Current modules: #
+## slugify ##
+creates unique slugs for assigned items.
+## 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: ###
+ model.publishDocument(id, function(err, result) {
+ console.log(result)
+ });
+
+

0 comments on commit 348fae9

Please sign in to comment.