diff --git a/README.md b/README.md index 2d5e4a3b..a3d8f52c 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ A scalable blockchain database. [The whitepaper](https://www.bigchaindb.com/whit ### [Install and Run BigchainDB Server](http://bigchaindb.readthedocs.org/en/develop/installing-server.html) ### [Run BigchainDB with Docker](http://bigchaindb.readthedocs.org/en/develop/installing-server.html#run-bigchaindb-with-docker) -### [Getting Started (Tutorial)](http://bigchaindb.readthedocs.org/en/develop/getting-started.html) +### [The Python Server API by Example](http://bigchaindb.readthedocs.org/en/develop/python-server-api-examples.html) ## Links for Everyone * [BigchainDB.com](https://www.bigchaindb.com/) - the main BigchainDB website, including newsletter signup diff --git a/docs/source/index.rst b/docs/source/index.rst index 0a864659..90096141 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -14,7 +14,7 @@ Table of Contents introduction installing-server - getting-started + python-server-api-examples bigchaindb-cli python-api-tutorial admin diff --git a/docs/source/getting-started.md b/docs/source/python-server-api-examples.md similarity index 90% rename from docs/source/getting-started.md rename to docs/source/python-server-api-examples.md index 130ec40d..cfb313ef 100644 --- a/docs/source/getting-started.md +++ b/docs/source/python-server-api-examples.md @@ -1,8 +1,12 @@ -# Getting Started (Tutorial) +# The Python Server API by Example -This section gives an example of using BigchainDB. We create a digital asset, sign it, write it to a BigchainDB instance, read it, transfer it to a different user, and then attempt to transfer it to another user, resulting in a double-spend error. +This section gives an example of using the Python Server API to interact _directly_ with a BigchainDB node running BigchainDB Server. That is, in this example, the Python code and BigchainDB Server run on the same machine. -## Getting Going +(One can also interact with a BigchainDB node via other APIs, including the HTTP Client-Server API.) + +We create a digital asset, sign it, write it to a BigchainDB Server instance, read it, transfer it to a different user, and then attempt to transfer it to another user, resulting in a double-spend error. + +## Getting Started First, make sure you have RethinkDB and BigchainDB _installed and running_, i.e. you [installed them](installing-server.html) and you ran: ```text