Merge pull request #99 from bigchaindb/documentation-js-driver

Documentation js driver
bigchaindb · Sep 22, 2017 · aa29ca0 · aa29ca0
2 parents c8e669e + 04ebb38
commit aa29ca0
Show file tree

Hide file tree

Showing 4 changed files with 413 additions and 3 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -5,7 +5,9 @@ BigchainDB Javascript Driver Documentation
 	:maxdepth: 2
 
 	← Back to All BigchainDB Docs <https://bigchaindb.readthedocs.io/en/latest/index.html>
+	readme
 	quickstart
+	usage
 
 
 Another header

diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
@@ -1,4 +1,9 @@
-Quickstart
-==========
+=========================
+Quickstart / Installation
+=========================
 
-Quickstart comes here
+Installation with package manager npm:
+
+.. code-block:: bash
+
+    $ npm install bigchaindb-driver
diff --git a/docs/source/readme.rst 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``                        |
++-----------------------+----------------------------------+