Update README.md

This commit is contained in:
Dimitri De Jonghe 2017-05-03 00:16:48 +02:00 committed by GitHub
parent a7d5e307d4
commit 9795df4e14
1 changed files with 8 additions and 25 deletions

View File

@ -23,39 +23,22 @@ of which I expect you'll know quite well ([otherwise, go check out js-reactor](h
### Install from npm ### Install from npm
``` ```bash
# install from npm
npm install js-bigchaindb-driver npm install js-bigchaindb-driver
``` # Install from GitHub - Depending on your GitHub login credentials (`ssh` or `https`)
### Install from GitHub
Depending on your GitHub login credentials
- ssh
```
npm install git+ssh://github.com/bigchaindb/js-bigchaindb-driver.git npm install git+ssh://github.com/bigchaindb/js-bigchaindb-driver.git
```
- https
```
npm install git+https://github.com/bigchaindb/js-bigchaindb-driver.git npm install git+https://github.com/bigchaindb/js-bigchaindb-driver.git
``` ```
### Browser / ES6 ### Import / ES6
```javascript ```javascript
// ES6
import * as driver from 'js-bigchaindb-driver'; import * as driver from 'js-bigchaindb-driver';
``` // ES<<6
### Browser / require
```javascript
let driver = require('js-bigchaindb-driver'); let driver = require('js-bigchaindb-driver');
``` // CommonJS / node
### CommonJS / node
```javascript
let driver = require('js-bigchaindb-driver/dist/node'); let driver = require('js-bigchaindb-driver/dist/node');
``` ```
@ -176,4 +159,4 @@ Transaction(secret)
### Connection ### Connection