Updated README

jasonpincin · Mar 13, 2013 · 3c18f6f · 3c18f6f
1 parent 5c8b41a
commit 3c18f6f
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -34,10 +34,11 @@ doSomethingSlow(timeout(function doSomethingSlowHandler (err) {
 var timeout = require('callback-timeout')
 ```
 
-## timeout(callback, ms)
+## timeout(callback, [ms])
 
 Returns a callback function that will execute after `ms` milliseconds with a single `Error` argument 
-if not invoked by other means first.
+if not invoked by other means first. If the `ms` timeout argument is omitted, 0, or null, then the timeout 
+is disabled and the original callback is returned.
 
 # install