Merge branch 'master' of https://github.com/BHBNETWORK/lightning-client-js

Author: isghe

README.md

@@ -1,3 +1,28 @@
 # lightning-client-js
 
 JavaScript [c-lightning](https://github.com/ElementsProject/lightning) client.
+
+This repository is published as the [`lightning-client`](https://www.npmjs.com/package/lightning-client) NPM module.
+
+## Installing the client
+
+You can easily install this client using `npm` by running:
+
+```
+npm install lightning-client
+```
+
+## Using the client
+
+Once the client is installed you can use it by loading the main class and instantiating it in this way:
+
+```
+const LightningClient = require('lightning-client');
+
+// This should point to your lightning-dir, by default in ~/.lightning
+const client = new LightningClient('/home/bitcoind/.lightning');
+
+// Every call returns a Promise
+client.getinfo()
+    .then(info => console.log(info));
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "lightning-client",
-  "version": "0.5.2-beta.1",
+  "version": "0.5.2-beta.2",
   "description": "JavaScript c-lightning client",
   "main": "index.js",
   "scripts": {