not on max restarts being changed

mafintosh · May 18, 2015 · 36a19da · 36a19da
1 parent 8747367
commit 36a19da
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,8 @@ monitor.start() // spawn and watch
 
 Optionally you can specify the command to to spawn in the option map as `command: [...]`
 
+Per default respawn will restart you app indefinitely. To set a max restart limit set the `maxRestarts` option.
+
 If `sleep` is an array of numbers it will use the value at the position of the current number of restarts as the timeout value. If the number of restarts exceed the length of the array it will use the last value in the array until it hits the maxRestarts.
 
 `sleep: [1000, 60000, 60000, 12000, 1000]` will wait 1000ms before retrying, then it will wait 60000 before the next retry and so forth.