Added timeout docs

kickboxio · Mar 16, 2015 · 1ce65c9 · 1ce65c9
1 parent ce181ec
commit 1ce65c9
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -37,6 +37,16 @@ kickbox.verify("[email protected]", function (err, response) {
   console.log(response.body);
 });
 ```
+
+#### Options
+
+**timeout** `integer` (optional) - Maximum time, in milliseconds, for the API to complete a verification request. Default: 6000.
+
+```js
+// Example with options
+kickbox.verify("[email protected]", {timeout: 6000}, function (err, response) {/*...*/});
+```
+
 ### Response information
 
 A successful API call responds with the following values: