From 112e9ec4a203a4e127c5136988e79c4c98881ee2 Mon Sep 17 00:00:00 2001
From: Bruno Dias <dias.h.bruno@gmail.com>
Date: Tue, 22 Mar 2016 22:12:41 -0300
Subject: [PATCH 03/11] added example to readme.

---
 readme.md | 45 +++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 43 insertions(+), 2 deletions(-)

diff --git a/readme.md b/readme.md
index ee379d0..bb34928 100644
--- a/readme.md
+++ b/readme.md
@@ -1,4 +1,45 @@
-bulkjs
-======
+# bulkjs
 
 base for a manager for multiple selection.
+
+## Example
+
+```javascript
+// the api.
+var bulkAction = bulk(scope, {
+    // toId maps the object from the data source,
+    // to the unique id in the list.
+    toId: function(x) {
+        return x.uuid;
+    },
+    // updates will always be executed for any change,
+    // except when settings the 'dataSource'.
+    update: function(scope, event, eventName) {
+        // get the list of selected ids.
+        var selected = scope.bulkAction.list();
+
+        // if not 'all', unmark the all checkbox.
+        if (!scope.bulkAction.all()) {
+            all[0].checked = '';
+        } else {
+            all[0].checked = 'checked';
+        }
+
+        // mark as checked if the uuid is in the selected list.
+        scope.collection.map(function(o, k) {
+            var checked = selected.indexOf(o.uuid) > -1;
+            o.content.checked = checked ? 'checked' : '';
+        });
+        // display info.
+        if (scope.bulkAction.all()) {
+            sl.html("all");
+        } else {
+            if (selected.length > 0) {
+                sl.html(selected.join(","));
+            } else {
+                sl.html("none");
+            }
+        }
+    }
+});
+```
-- 
2.6.4