Updated the documentation and the JS file header comment block. Added Parameters section with explanations. Added Options section with explanations, accepted and default values.

Author: Jakobud

README.md

@@ -1,9 +1,7 @@
 ReconnectingWebSocket
 =====================
 
-A small JavaScript library that decorates the WebSocket API to provide
-a WebSocket connection that will automatically reconnect if the
-connection is dropped.
+A small JavaScript library that decorates the WebSocket API to provide a WebSocket connection that will automatically reconnect if the connection is dropped.
 
 It is API compatible, so when you have:
 
@@ -48,12 +46,57 @@ With a `ReconnectingWebSocket`, after an `onclose` event is called it will autom
 
 This is all handled automatically for you by the library.
 
-More
-----
+## Parameters
+
+`var socket = new ReconnectingWebSocket(url, protocols, options);`
+
+#### `url`
+- The URL you are connecting to.
+- http://dev.w3.org/html5/websockets/#the-websocket-interface
+
+#### `protocols`
+- Optional string or array of protocols per the WebSocket spec.
+- [http://dev.w3.org/html5/websockets/#refsWSP
+
+#### `options`
+- Options (see below)
+
+## Options
+
+Options can either be passed as the 3rd parameter upon instantiation or set directly on the object after instantiation:
+
+`var socket = new ReconnectingWebSocket(url, null, {debug: true, reconnectInterval: 3000});`
+
+or
+
+    var socket = new ReconnectingWebSocket(url);
+    socket.debug = true;
+    socket.timeoutInterval = 5400;
+
+#### `debug`
+- Whether this instance should log debug messages or not. Debug messages are printed to `console.debug()`.
+- Accepts `true` or `false`
+- Default value: `false`
+
+#### `reconnectInterval`
+- The number of milliseconds to delay before attempting to reconnect.
+- Accepts `integer`
+- Default: `1000`
+
+####`reconnectDecay`
+- The rate of increase of the reconnect delay. Allows reconnect attempts to back off when problems persist.
+- Accepts `integer` or `float`
+- Default: `1.5`
+
+#### `timeoutInterval` - `[integer]`
+- The maximum time in milliseconds to wait for a connection to succeed before closing and retrying.
+- Accepts `integer`
+- Default: `2000`
+
+---
 
 Like this? Check out [websocketd](https://github.com/joewalnes/websocketd) for the simplest way to create WebSocket backends from any programming language.
 
 [Follow @joewalnes](https://twitter.com/joewalnes)
 
 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/joewalnes/reconnecting-websocket/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-

reconnecting-websocket.js

@@ -50,6 +50,41 @@
  *
  * Latest version: https://github.com/joewalnes/reconnecting-websocket/
  * - Joe Walnes
+ *
+ * Syntax
+ * ======
+ * var socket = new ReconnectingWebSocket(url, protocols, options);
+ *
+ * Parameters
+ * ==========
+ * url - The url you are connecting to.
+ * protocols - Optional string or array of protocols.
+ * options - See below
+ *
+ * Options
+ * =======
+ * Options can either be passed upon instantiation or set after instantiation:
+ *
+ * var socket = new ReconnectingWebSocket(url, null, { debug: true, reconnectInterval: 4000 });
+ *
+ * or
+ *
+ * var socket = new ReconnectingWebSocket(url);
+ * socket.debug = true;
+ * socket.reconnectInterval = 4000;
+ *
+ * debug
+ * - Whether this instance should log debug messages. Accepts true or false. Default: false.
+ *
+ * reconnectInterval
+ * - The number of milliseconds to delay before attempting to reconnect. Accepts integer. Default: 1000.
+ *
+ * reconnectDecay
+ * - The rate of increase of the reconnect delay. Allows reconnect attempts to back off when problems persist. Accepts integer or float. Default: 1.5.
+ *
+ * timeoutInterval
+ * - The maximum time in milliseconds to wait for a connection to succeed before closing and retrying. Accepts integer. Default: 2000.
+ *
  */
 (function (global, factory) {
     if (typeof define === 'function' && define.amd) {