Moar docs

README.md

@@ -29,7 +29,7 @@ Options
 
   -d, --delay   [default=1000ms] Waiting time between spawning workers.
 
-  -r, --retries   [default=Infinity] Max number of call requeues after unexpected worker termination.
+  -r, --retries [default=Infinity] Max number of call requeues after unexpected worker termination.
 
 It's possible to load [options] from file, creating '.farm' JSON file on the path of <file>.
 

bin/cli/help.txt

@@ -8,7 +8,7 @@ Options
 
   -d, --delay   [default=1000ms] Waiting time between spawning workers.
 
-  -r, --retries   [default=Infinity] Max number of call requeues after unexpected worker termination.
+  -r, --retries [default=Infinity] Max number of call requeues after unexpected worker termination.
 
 It's possible to load [options] from file, creating '.farm' JSON file on the path of <file>.
 

example/load-config/.farm

@@ -0,0 +1,4 @@
+{
+  "maxConcurrentWorkers" : 1,
+  "delay": 5000
+}

example/load-config/README.md

@@ -0,0 +1,5 @@
+# Basic
+
+```bash
+$ DEBUG=worker-farm-cli worker-farm -w 2 -n 5 -d 0 example/basic --your-file-flags foo=bar
+```

example/load-config/index.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = function (opts) {}

example/throw-error/README.md

@@ -0,0 +1,7 @@
+# throw-error
+
+If the process throw an error, then the child worker will spawned again.
+
+```bash
+$ DEBUG=worker-farm-cli worker-farm -w 1 -n 1 -d 0 example/throw-error --your-file-flags foo=bar
+```

example/throw-error/index.js

@@ -0,0 +1,5 @@
+'use strict'
+
+module.exports = function (opts, cb) {
+  throw new Error('Something bad happens')
+}

package.json

@@ -5,7 +5,7 @@
   "version": "1.3.3",
   "main": "bin",
   "bin": {
-    "farm": "bin/cli/index.js"
+    "worker-farm": "bin/cli/index.js"
   },
   "author": {
     "email": "josefrancisco.verdu@gmail.com",