Updated readme with new changes and options

Author: stianeikeland

README.md

@@ -22,6 +22,11 @@ $ npm install node-etcd@3.0.2
 
 ## Changes
 
+- 5.0.0
+  - Supports basic auth.
+  - Breaking: Constructor changes
+  - Breaking: Must provide https url to use https
+
 - 4.2.1
   - Newer deasync fixes issues with iojs 3.3.0 and nodejs 4.0.0.
 - 4.1.0
@@ -76,24 +81,39 @@ $ npm install node-etcd@3.0.2
 ## Basic usage
 
 ```javascript
-Etcd = require('node-etcd');
-etcd = new Etcd();
+var Etcd = require('node-etcd');
+var etcd = new Etcd();
 etcd.set("key", "value");
 etcd.get("key", console.log);
 ```
 
+Callbacks follows the default (error, result) nodejs convention:
+
+```javascript
+function callback(err, res) {
+    console.log("Error: ", err);
+    console.log("Return: ", res);
+}
+etcd.get("key", callback);
+// Error: null
+// Return: { action: 'get', node: { key: '/key', value: 'value', modifiedIndex: 4, createdIndex: 4 } }
+```
+
 ## Methods
 
-### Etcd([host = '127.0.0.1'], [port = '4001'], [ssloptions])
+### Etcd(hosts = ['127.0.0.1:4001'], [options])
 
 Create a new etcd client for a single host etcd setup
 
 ```javascript
 etcd = new Etcd();
-etcd = new Etcd('127.0.0.1', '4001');
+etcd = new Etcd("127.0.0.1:4001");
+etcd = new Etcd("http://127.0.0.1:4001");
+etcd = new Etcd("https://127.0.0.1:4001");
+etcd = new Etcd(["http://127.0.0.1:4001"]);
 ```
 
-### Etcd(hosts, [ssloptions])
+### Etcd(hosts, [options])
 
 Create a new etcd client for a clustered etcd setup. Client will connect to
 servers in random order. On failure it will try the next server. When all
@@ -103,6 +123,7 @@ retries can be controlled by adding `{ maxRetries: x }` as an option to requests
 
 ```javascript
 etcd = new Etcd(['127.0.0.1:4001','192.168.1.1:4001']);
+etcd = new Etcd(['http://127.0.0.1:4001','http://192.168.1.1:4001']);
 ```
 
 ### .set(key, value = null, [options], [callback])
@@ -396,20 +417,44 @@ you won't get any callbacks from the request after calling `.abort()`.
 
 ## SSL support
 
-Pass etcdclient a dictionary containing ssl options, check out http://nodejs.org/api/https.html#https_https_request_options_callback
+Provide `ca`, `cert`, `key` as options. Remember to use `https`-url.
 
 ```javascript
-fs = require('fs');
+var fs = require('fs');
 
-sslopts = {
-	ca: [ fs.readFileSync('ca.pem') ],
+var options = {
+	ca:   fs.readFileSync('ca.pem'),
 	cert: fs.readFileSync('cert.pem'),
-	key: fs.readFileSync('key.pem')
+	key:  fs.readFileSync('key.pem')
 };
 
-etcdssl = new Etcd('localhost', '4001', sslopts);
+var etcdssl = new Etcd("https://localhost:4001", options);
 ```
 
+## Basic auth
+
+Pass a hash containing username and password as auth option to use basic auth.
+
+```javascript
+var auth = {
+    user: "username",
+    pass: "password"
+}
+
+var etcd = new Etcd("localhost:4001", { auth: auth });
+```
+
+## Constructor options
+
+Useful constructor options include:
+
+- `timeout` - Integer request timeout in milliseconds to wait for server response.
+- `ca` - Ca certificate
+- `cert` - Client certificate
+- `key` - Client key
+- `passphrase` - Client key passphrase
+- `auth` - A hash containing `{user: "username", pass: "password"}` for basic auth.
+
 ## FAQ:
 
 - Are there any order of execution guarantees when doing multiple requests without using callbacks?