Skip to content

Commit 5942cf1

Browse files
authored
Update README.md
1 parent 91eac50 commit 5942cf1

File tree

1 file changed

+49
-3
lines changed

1 file changed

+49
-3
lines changed

README.md

Lines changed: 49 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
## c-bigchaindb-tx
2-
3-
Transaction buider and signer.
41

2+
Install
3+
----------
54
```
65
mkdir build
76
cd build/
@@ -14,3 +13,50 @@ When building the metadata and asset objects take the following measures:
1413
1. No spaces in the json structure: ```{"key 1": "value a"}``` becomes ```'{"key 2":"value a"}'```
1514
2. Keys should be alphabetically ordered: ```{"key 1":"value a","A key":"A value"}``` becomes ```{"A key":"A value","key 1":"value a"}```
1615
3. No numbers fields, only strings ```{"key 1":2.3123}``` becomes ```{"key 1":"2.3123"}```
16+
17+
18+
BigchainDB Documentation
19+
------------------------------------
20+
* `BigchainDB Server Quickstart`_
21+
* `The Hitchhiker's Guide to BigchainDB`_
22+
* `HTTP API Reference`_
23+
* `All BigchainDB Documentation`_
24+
25+
Usage
26+
----------
27+
Example: Create a divisible asset for Alice who issues 10 token to Bob so that he can use her Game Boy.
28+
Afterwards Bob spends 3 of these tokens.
29+
30+
If you want to send a transaction you need to `Determine the BigchainDB Root URL`_.
31+
32+
33+
Compatibility Matrix
34+
--------------------
35+
36+
+-----------------------+---------------------------+
37+
| **BigchainDB Server** | **BigchainDB Driver** |
38+
+=======================+===========================+
39+
| ``>= 2.0.0b7`` | ``0.6.2`` |
40+
+-----------------------+---------------------------+
41+
42+
License
43+
--------
44+
* `licenses`_ - open source & open content
45+
46+
Credits
47+
-------
48+
49+
This package was initially created using Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. Many BigchainDB developers have contributed since then.
50+
51+
.. _Documentation: https://docs.bigchaindb.com/projects/py-driver/
52+
.. _pypi history: https://pypi.org/project/bigchaindb-driver/#history
53+
.. _Quickstart: https://docs.bigchaindb.com/projects/py-driver/en/latest/quickstart.html
54+
.. _BigchainDB Server Quickstart: https://docs.bigchaindb.com/projects/server/en/latest/quickstart.html
55+
.. _The Hitchhiker's Guide to BigchainDB: https://www.bigchaindb.com/developers/guide/
56+
.. _HTTP API Reference: https://docs.bigchaindb.com/projects/server/en/latest/http-client-server-api.html
57+
.. _All BigchainDB Documentation: https://docs.bigchaindb.com/
58+
.. _Determine the BigchainDB Root URL: https://docs.bigchaindb.com/projects/py-driver/en/latest/connect.html
59+
.. _licenses: https://github.com/bigchaindb/bigchaindb-driver/blob/master/LICENSES.md
60+
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
61+
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
62+
Transaction buider and signer.

0 commit comments

Comments
 (0)