diff --git a/docs/source/readme.rst b/docs/source/readme.rst index 97278cd..a30d405 100644 --- a/docs/source/readme.rst +++ b/docs/source/readme.rst @@ -44,24 +44,25 @@ Compatibility Matrix Older versions -------------------- -#### Versions 4.x.x - +**Versions 4.x.x** As part of the changes in the BigchainDB 2.0 server, some endpoint were modified. In order to be consistent with them, the JS driver does not have -anymore the `pollStatusAndFetchTransaction()` method as there are three +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. +- *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 +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 transfer the asset immediately. -#### Versions 3.2.x + +**Versions 3.2.x ** + For versions below 3.2, a transfer transaction looked like: