Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #668 from bigchaindb/update-warning-on-example-apps-page

Browse Source 
Docs: updated warning/explanation on the Example Apps page
This commit is contained in:
Troy McConaghy 2016-10-10 16:26:38 +02:00 committed by GitHub
commit 7dec1dc595
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/source/drivers-clients/example-apps.md
View File

@ -1,5 +0,0 @@
# Example Apps
There are some example BigchainDB apps (i.e. apps which use BigchainDB) in [the GitHub repository named bigchaindb-examples](https://github.com/bigchaindb/bigchaindb-examples).
As noted there, the examples are for demonstration purposes only and should not be used as-is for production.

10
docs/source/drivers-clients/example-apps.rst Normal file
View File

@ -0,0 +1,10 @@
Example Apps
============
.. warning::
There are some example BigchainDB apps (i.e. apps which use BigchainDB) in the GitHub repository named `bigchaindb-examples <https://github.com/bigchaindb/bigchaindb-examples>`_. They were created before there was much of an HTTP API, so instead of communicating with a BigchainDB node via the HTTP API, they communicate directly with the node using the BigchainDB Python server API and the RethinkDB Python Driver. That's not how a real production app would work. The HTTP API is getting better, and we recommend using it to communicate with BigchainDB nodes.
Moreover, because of changes to the BigchainDB Server code, some of the examples in the bigchaindb-examples repo might not work anymore, or they might not work as expected.
In the future, we hope to create a set of examples using the HTTP API (or wrappers of it, such as the Python Driver API).