Merge pull request #162 from bigchaindb/format-docs

Format docs

README.md

@@ -18,9 +18,13 @@
 | `0.10`            | `0.1.x`                      |
 | `1.0.0`        | `0.3.x`                      |
 | `>= 1.3.0`        | `3.x.x`                      |
+| `>= 2.0.0`        | `4.x.x`                      |
 
 ## Breaking changes
-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)
+
+- **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)
+
 
 ## Contents
 
@@ -71,8 +75,7 @@ const txSigned = driver.Transaction.signTransaction(tx, alice.privateKey)
 // Send the transaction off to BigchainDB
 const conn = new driver.Connection(API_PATH)
 
-conn.postTransaction(txSigned)
+conn.postTransactionCommit(txSigned)
-    .then(() => conn.pollStatusAndFetchTransaction(txSigned.id))
     .then(retrievedTx => console.log('Transaction', retrievedTx.id, 'successfully posted.'))
 ```
 
@@ -85,7 +88,7 @@ conn.postTransaction(txSigned)
         <meta charset="utf-8">
         <title>BigchainDB boilerplate</title>
         <!-- Adjust version to your needs -->
-        <script src="https://unpkg.com/bigchaindb-driver@0.3.0/dist/browser/bigchaindb-driver.window.min.js"></script>
+        <script src="https://unpkg.com/bigchaindb-driver@4.0.0/dist/browser/bigchaindb-driver.window.min.js"></script>
 
         <script>
             // BigchainDB server instance or IPDB (e.g. https://test.ipdb.io/api/v1/)
@@ -117,8 +120,7 @@ conn.postTransaction(txSigned)
             // Send the transaction off to BigchainDB
             let conn = new BigchainDB.Connection(API_PATH)
 
-            conn.postTransaction(txSigned)
+            conn.postTransactionCommit(txSigned)
-                .then(() => conn.pollStatusAndFetchTransaction(txSigned.id))
                 .then(res => {
                     const elem = document.getElementById('lastTransaction')
                     elem.href = API_PATH + 'transactions/' + txSigned.id

docs/source/readme.rst

@@ -44,28 +44,27 @@ Compatibility Matrix
 Older versions
 --------------------
 
-#### Versions 4.x.x
+**Version 4.x.x**
+
+	As part of the changes in the BigchainDB 2.0 server, some endpoints were
+	modified. In order to be consistent with them, the JS driver does not have
+	anymore the `pollStatusAndFetchTransaction()` method as there are three
+	different ways of posting a transaction:
+
+	- `async` using the `postTransaction`: the response will return immediately and not wait to see if the transaction is valid.
+	- `sync` using the `postTransactionSync`: the response will return after the transaction is validated.
+	- `commit` using the `postTransactionCommit`: the response will return after the transaction is committed to a block.
+
+	By default in the docs we will use the `postTransactionCommit` as is way of
+	being sure that the transaction is validated and commited to a block, so
+	there will not be any issue if you try to do any other action with the asset immediately.
 
 
+**Version 3.2.x**
 
-As part of the changes in the BigchainDB 2.0 server, some endpoint were
+	For versions below 3.2, a transfer transaction looked like:
-modified. In order to be consistent with them, the JS driver does not have
-anymore the `pollStatusAndFetchTransaction()` method as there are three
-different ways of posting a transaction.
-- `async` using the `postTransaction`: the response will return immediately and not wait to see if the transaction is valid.
-- `sync` using the `postTransactionSync`: the response will return after the transaction is validated.
-- `commit` using the `postTransactionCommit`: the response will return after the transaction is committed to a block.
 
-By default in the docs we will use the `postTransactionCommit` as is way of
+	.. code-block:: js
-being sure that the transaction is validated and commited to a block, so
-there will not be any issue if you try to transfer the asset immediately.
-
-
-#### Versions 3.2.x 
-
-For versions below 3.2, a transfer transaction looked like:
-
-.. code-block:: js
 
 		const createTranfer = BigchainDB.Transaction.makeTransferTransaction(
 		    txCreated,
@@ -78,10 +77,10 @@ For versions below 3.2, a transfer transaction looked like:
 			keypair.privateKey)
 
 
-In order to upgrade and do it compatible with the new driver version, this
+	In order to upgrade and do it compatible with the new driver version, this
-transaction should be now:
+	transaction should be now:
 
-.. code-block:: js
+	.. code-block:: js
 
 		const createTranfer = BigchainDB.Transaction.makeTransferTransaction(
 			[{ tx: txCreated, output_index: 0 }],
@@ -94,12 +93,12 @@ transaction should be now:
 			keypair.privateKey)
 
 
-The upgrade allows to create transfer transaction spending outputs that belong
+	The upgrade allows to create transfer transaction spending outputs that belong
-to different transactions. So for instance is now possible to create a transfer
+	to different transactions. So for instance is now possible to create a transfer
-transaction spending two outputs from two different create transactions:
+	transaction spending two outputs from two different create transactions:
 
 
-.. code-block:: js
+	.. code-block:: js
 
 		const createTranfer = BigchainDB.Transaction.makeTransferTransaction(
 			[{ tx: txCreated1, output_index: 0 },