From 691fadfd9887d59fcff4877d9f90521da11ef950 Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Mon, 14 May 2018 14:06:44 +0200 Subject: [PATCH 1/2] readme updates * update TOC * tweak documentation links * remnove IPDB references --- README.md | 40 +++++++++++++++++++++++++--------------- 1 file changed, 25 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 44cfca6..ad0440d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # [![js-bigchaindb-driver](media/repo-banner@2x.png)](https://www.bigchaindb.com) -> 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. +> Official JavaScript driver for [BigchainDB](https://github.com/bigchaindb/bigchaindb) to create transactions in Node.js and the browser. [![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) [![npm](https://img.shields.io/npm/v/bigchaindb-driver.svg)](https://www.npmjs.com/package/bigchaindb-driver) @@ -9,15 +9,16 @@ [![Build Status](https://travis-ci.org/bigchaindb/js-bigchaindb-driver.svg?branch=master)](https://travis-ci.org/bigchaindb/js-bigchaindb-driver) [![Greenkeeper badge](https://badges.greenkeeper.io/bigchaindb/js-bigchaindb-driver.svg)](https://greenkeeper.io/) -- Documentation: https://docs.bigchaindb.com/projects/js-driver/en/latest/usage.html +- [Main Documentation](https://docs.bigchaindb.com/projects/js-driver/en/latest/usage.html) +- [Driver API reference](API.md) ## Compatibility | BigchainDB Server | BigchainDB JavaScript Driver | | ----------------- |------------------------------| | `0.10` | `0.1.x` | -| `1.0.0` | `0.3.x` | -| `1.3.x` | `3.x.x` | +| `1.0.0` | `0.3.x` | +| `1.3.x` | `3.x.x` | | `>= 2.0.0` | `4.x.x` | ## Breaking changes @@ -25,28 +26,36 @@ - **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) - **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) +## Table of Contents -## Contents + - [Installation and Usage](#installation-and-usage) + - [Example: Create a transaction](#example-create-a-transaction) + - [Browser usage](#browser-usage) + - [BigchainDB Documentation](#bigchaindb-documentation) + - [Speed Optimizations](#speed-optimizations) + - [Authors](#authors) + - [License](#license) -* [Installation and Usage with package managers (npm/yarn)](#installation-and-usage-with-package-managers-npmyarn) - * [Example: Create a transaction](#example-create-a-transaction) -* [Use a pre-built image (browser only)](#use-a-pre-built-image-browser-only) -* [Documentation](#bigchaindb-documentation) -* [Authors](#authors) -* [License](#license) +--- -## Installation and Usage with package managers (npm/yarn) +## Installation and Usage ```bash npm install bigchaindb-driver ``` +```js +const driver = require('bigchaindb-driver') +// or ES6+ +import driver from 'bigchaindb-driver' +``` + ### Example: Create a transaction ```js const driver = require('bigchaindb-driver') -// BigchainDB server instance or IPDB (e.g. https://test.ipdb.io/api/v1/) +// BigchainDB server instance (e.g. https://test.bigchaindb.com/api/v1/) const API_PATH = 'http://localhost:9984/api/v1/' // Create a new keypair. @@ -79,7 +88,7 @@ conn.postTransactionCommit(txSigned) .then(retrievedTx => console.log('Transaction', retrievedTx.id, 'successfully posted.')) ``` -## Use a pre-built image (browser only) +### Browser usage ```html @@ -91,7 +100,7 @@ conn.postTransactionCommit(txSigned)