diff --git a/docs/source/index.rst b/docs/source/index.rst index be9187f..84ad105 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -5,6 +5,7 @@ BigchainDB Javascript Driver Documentation :maxdepth: 2 ← Back to All BigchainDB Docs + readme quickstart diff --git a/docs/source/readme.rst b/docs/source/readme.rst new file mode 100644 index 0000000..36d4f5c --- /dev/null +++ b/docs/source/readme.rst @@ -0,0 +1,36 @@ +BigchainDB JavaScript Driver +============================ + +.. image:: https://img.shields.io/npm/v/bigchaindb-driver.svg + :target: https://www.npmjs.com/package/bigchaindb-driver + +.. image:: https://codecov.io/gh/bigchaindb/js-bigchaindb-driver/branch/master/graph/badge.svg + :target: https://codecov.io/gh/bigchaindb/js-bigchaindb-driver + +.. image:: https://img.shields.io/badge/js-ascribe-39BA91.svg + :target: https://github.com/ascribe/javascript + +.. image:: https://travis-ci.org/bigchaindb/js-bigchaindb-driver.svg?branch=master + :target: https://travis-ci.org/bigchaindb/js-bigchaindb-driver + +.. image:: https://badges.greenkeeper.io/bigchaindb/js-bigchaindb-driver.svg + :target: https://greenkeeper.io/ + +Features +-------- + +* Support for preparing, fulfilling, and sending transactions to a BigchainDB + node. +* Retrieval of transactions by id. +* Getting status of a transaction by id. + +Compatibility Matrix +-------------------- + ++-----------------------+----------------------------------+ +| **BigchainDB Server** | **BigchainDB Javascript Driver** | ++=======================+==================================+ +| ``0.10`` | ``0.1.x`` | ++-----------------------+----------------------------------+ +| ``1.0`` | ``0.3.x`` | ++-----------------------+----------------------------------+