Merge pull request #55 from bbc/promises

Feature: Expose Client for simpler promisification

README.md

@@ -25,6 +25,7 @@ npm install --save flashheart
 * [StatsD integration](#stats)
 * [Retries](#retries)
 * [Circuit breaker](#circuit-breaker)
+* [Promises](#promises)
 
 ## Usage
 
@@ -217,6 +218,21 @@ const client = require('flashheart').createClient({
 });
 ```
 
+### Promises
+
+Flashheart uses callbacks, but we expose the `Client` constructor to make it easy to [promisify](http://bluebirdjs.com/docs/api/promisification.html) the entire library:
+
+```js
+const Promise = require('bluebird');
+const Client = require('flashheart').Client;
+const client = require('flashheart').createClient();
+
+Promise.promisifyAll(Client.prototype);
+
+client.getAsync('http://httpstat.us/200')
+  .then((body) => console.log(body));
+```
+
 ## API
 
 #### Callback return values

index.js

@@ -13,3 +13,5 @@ module.exports.createClient = function (opts) {
 
   return client;
 };
+
+module.exports.Client = Client;