diff --git a/README.md b/README.rst similarity index 68% rename from README.md rename to README.rst index 6f8454d..9fa190b 100644 --- a/README.md +++ b/README.rst @@ -1,11 +1,11 @@ api.ai: Python SDK for `API.AI `_ -========================= +================================================ .. image:: https://badge.fury.io/py/apiai.svg :target: http://badge.fury.io/py/apiai -.. image:: https://travis-ci.org/api-ai/api-ai-python.svg - :target: https://travis-ci.org/api-ai/api-ai-python +.. image:: https://travis-ci.org/dialogflow/dialogflow-python-client.svg + :target: https://travis-ci.org/dialogflow/dialogflow-python-client Overview @@ -14,13 +14,13 @@ Overview The API.AI Python SDK makes it easy to integrate speech recognition with API.AI natural language processing API. API.AI allows using voice commands and integration with dialog scenarios defined for a particular agent in API.AI. Prerequsites --------- +------------ Create an `API.AI account `_. Running examples --------- +---------------- 1. Find examples from 'examples' path. 2. Insert API key. @@ -50,7 +50,7 @@ or install it from repo: .. code-block:: bash - $ pip install https://github.com/api-ai/api-ai-python.git + $ pip install git+https://github.com/dialogflow/dialogflow-python-client.git You might run into problems because some dependencies in your python environment are missing. You need to install numpy (which is available in almost all package managers). For running the examples you also need python audio. @@ -67,12 +67,12 @@ Documentation Documentation is available at http://api.ai. ## How to make contributions? -Please read and follow the steps in the [CONTRIBUTING.md](CONTRIBUTING.md). +Please read and follow the steps in the `CONTRIBUTING `_. ## License -See [LICENSE](LICENSE). +See `LICENSE `_. ## Terms -Your use of this sample is subject to, and by using or downloading the sample files you agree to comply with, the [Google APIs Terms of Service](https://developers.google.com/terms/). +Your use of this sample is subject to, and by using or downloading the sample files you agree to comply with, the `Google APIs Terms of Service `_. This is not an official Google product. \ No newline at end of file