Merge branch 'master' into feature/styling-functional

This commit is contained in:
diminator 2017-05-03 01:28:18 +02:00
commit e0756b1359
1 changed files with 9 additions and 25 deletions

View File

@ -23,39 +23,23 @@ of which I expect you'll know quite well ([otherwise, go check out js-reactor](h
### Install from npm
```
```bash
# install from npm
npm install js-bigchaindb-driver
```
### Install from GitHub
Depending on your GitHub login credentials
- ssh
```
# Install from GitHub - ssh
npm install git+ssh://github.com/bigchaindb/js-bigchaindb-driver.git
```
- https
```
# Install from GitHub - https
npm install git+https://github.com/bigchaindb/js-bigchaindb-driver.git
```
### Browser / ES6
### Import / ES6
```javascript
// ES6 Browser
import * as driver from 'js-bigchaindb-driver';
```
### Browser / require
```javascript
// ES<<6 Browser
let driver = require('js-bigchaindb-driver');
```
### CommonJS / node
```javascript
// ES<<6 CommonJS / node
let driver = require('js-bigchaindb-driver/dist/node');
```
@ -157,4 +141,4 @@ An example BigchainDB Server-generated keypair (encoded in `base58`):
- Private: `7Gf5YRch2hYTyeLxqNLgTY63D9K5QH2UQ7LYFeBGuKvo`
Your package should be able to take in the decoded version of the **private** key and return you the
same **public** key (once you encode that to `base58`).
same **public** key (once you encode that to `base58`).