diff --git a/docs/source/drivers-clients/example-apps.md b/docs/source/drivers-clients/example-apps.md deleted file mode 100644 index e66cffea..00000000 --- a/docs/source/drivers-clients/example-apps.md +++ /dev/null @@ -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. diff --git a/docs/source/drivers-clients/example-apps.rst b/docs/source/drivers-clients/example-apps.rst new file mode 100644 index 00000000..0aab953e --- /dev/null +++ b/docs/source/drivers-clients/example-apps.rst @@ -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 `_. 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).