Skip to content

Commit 691fadf

Browse files
kremaliciouskremalicious
committed
readme updates
* update TOC * tweak documentation links * remnove IPDB references
1 parent 4570b24 commit 691fadf

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

‎README.md

+25-15
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# [![js-bigchaindb-driver](media/repo-banner@2x.png)](https://www.bigchaindb.com)
22

3-
> Official JavaScript driver for [BigchainDB](https://github.com/bigchaindb/bigchaindb) with some naive helpers to get you on your way making transactions in Node.js and the browser.
3+
> Official JavaScript driver for [BigchainDB](https://github.com/bigchaindb/bigchaindb) to create transactions in Node.js and the browser.
44
55
[![Join the chat at https://gitter.im/bigchaindb/js-bigchaindb-driver](https://badges.gitter.im/bigchaindb/js-bigchaindb-driver.svg)](https://gitter.im/bigchaindb/js-bigchaindb-driver?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
66
[![npm](https://img.shields.io/npm/v/bigchaindb-driver.svg)](https://www.npmjs.com/package/bigchaindb-driver)
@@ -9,44 +9,53 @@
99
[![Build Status](https://travis-ci.org/bigchaindb/js-bigchaindb-driver.svg?branch=master)](https://travis-ci.org/bigchaindb/js-bigchaindb-driver)
1010
[![Greenkeeper badge](https://badges.greenkeeper.io/bigchaindb/js-bigchaindb-driver.svg)](https://greenkeeper.io/)
1111

12-
- Documentation: https://docs.bigchaindb.com/projects/js-driver/en/latest/usage.html
12+
- [Main Documentation](https://docs.bigchaindb.com/projects/js-driver/en/latest/usage.html)
13+
- [Driver API reference](API.md)
1314

1415
## Compatibility
1516

1617
| BigchainDB Server | BigchainDB JavaScript Driver |
1718
| ----------------- |------------------------------|
1819
| `0.10` | `0.1.x` |
19-
| `1.0.0` | `0.3.x` |
20-
| `1.3.x` | `3.x.x` |
20+
| `1.0.0` | `0.3.x` |
21+
| `1.3.x` | `3.x.x` |
2122
| `>= 2.0.0` | `4.x.x` |
2223

2324
## Breaking changes
2425

2526
- **Version 4.0** of BigchainDB JavaScript Driver makes the driver compatible with BigchainDB 2.0. There are new functions for sending off transactions along with other changes. Check [older versions](https://docs.bigchaindb.com/projects/js-driver/en/latest/readme.html#features)
2627
- **Version 3.2** of BigchainDB JavaScript Driver introduces a new way of creating transfer transactions. Check [older versions](https://docs.bigchaindb.com/projects/js-driver/en/latest/readme.html#features)
2728

29+
## Table of Contents
2830

29-
## Contents
31+
- [Installation and Usage](#installation-and-usage)
32+
- [Example: Create a transaction](#example-create-a-transaction)
33+
- [Browser usage](#browser-usage)
34+
- [BigchainDB Documentation](#bigchaindb-documentation)
35+
- [Speed Optimizations](#speed-optimizations)
36+
- [Authors](#authors)
37+
- [License](#license)
3038

31-
* [Installation and Usage with package managers (npm/yarn)](#installation-and-usage-with-package-managers-npmyarn)
32-
* [Example: Create a transaction](#example-create-a-transaction)
33-
* [Use a pre-built image (browser only)](#use-a-pre-built-image-browser-only)
34-
* [Documentation](#bigchaindb-documentation)
35-
* [Authors](#authors)
36-
* [License](#license)
39+
---
3740

38-
## Installation and Usage with package managers (npm/yarn)
41+
## Installation and Usage
3942

4043
```bash
4144
npm install bigchaindb-driver
4245
```
4346

47+
```js
48+
const driver = require('bigchaindb-driver')
49+
// or ES6+
50+
import driver from 'bigchaindb-driver'
51+
```
52+
4453
### Example: Create a transaction
4554

4655
```js
4756
const driver = require('bigchaindb-driver')
4857

49-
// BigchainDB server instance or IPDB (e.g. https://test.ipdb.io/api/v1/)
58+
// BigchainDB server instance (e.g. https://test.bigchaindb.com/api/v1/)
5059
const API_PATH = 'http://localhost:9984/api/v1/'
5160

5261
// Create a new keypair.
@@ -79,7 +88,7 @@ conn.postTransactionCommit(txSigned)
7988
.then(retrievedTx => console.log('Transaction', retrievedTx.id, 'successfully posted.'))
8089
```
8190

82-
## Use a pre-built image (browser only)
91+
### Browser usage
8392

8493
```html
8594
<!DOCTYPE html>
@@ -91,7 +100,7 @@ conn.postTransactionCommit(txSigned)
91100
<script src="https://unpkg.com/bigchaindb-driver@4.0.0/dist/browser/bigchaindb-driver.window.min.js"></script>
92101

93102
<script>
94-
// BigchainDB server instance or IPDB (e.g. https://test.ipdb.io/api/v1/)
103+
// BigchainDB server instance (e.g. https://test.bigchaindb.com/api/v1/)
95104
const API_PATH = 'http://localhost:9984/api/v1/'
96105
97106
// Create a new keypair.
@@ -139,6 +148,7 @@ conn.postTransactionCommit(txSigned)
139148

140149
## BigchainDB Documentation
141150

151+
- [The Hitchhiker's Guide to BigchainDB](https://www.bigchaindb.com/developers/guide/)
142152
- [HTTP API Reference](https://docs.bigchaindb.com/projects/server/en/latest/http-client-server-api.html)
143153
- [The Transaction Model](https://docs.bigchaindb.com/projects/server/en/latest/data-models/transaction-model.html?highlight=crypto%20conditions)
144154
- [Inputs and Outputs](https://docs.bigchaindb.com/projects/server/en/latest/data-models/inputs-outputs.html)

0 commit comments

Comments
 (0)