level-trigger - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "level-trigger",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "homepage": "https://github.com/dominictarr/level-trigger",
@@ -5,0 +5,0 @@ "repository": {

README.md

 # level-trigger
 
+Triggers for levelup.
+
 <img src=https://secure.travis-ci.org/dominictarr/level-trigger.png?branch=master>
 
+Jobs must be idempotent!
+If the process crashes before job has calledback,
+it will be rerun the next time it's started, for consistency!
 
+# Example
+
+``` js
+var trigger = require('level-trigger')
+trigger(db)
+
+db.trigger.add({
+  name: 'example',
+  start: 'A', end: '~',
+  mapKey: function (key) {
+    //optionally index the job with a different key.
+    //if there are two jobs with the same key,
+    //it will only be triggered once.
+    return key
+  },
+  job: function (value, done) { 
+    //call done when job is done.
+    done()
+  }
+})
+
+```
+
 ## License
 
 MIT
+
+
+

No alert changes

Improved metrics

Total package byte prevSize

5268

increased by12.11%

Number of lines in readme file

40

increased by344.44%

No dependency changes