From e20427c5c8e4a63067d38e607930393c4f58537a Mon Sep 17 00:00:00 2001 From: Sarath S Pillai Date: Sun, 24 Sep 2017 09:53:01 +0530 Subject: [PATCH] Update README.md Corrections to make README presentable as proper markdown --- README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 6f8454d..9ffb015 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,8 @@ 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 +[![pypi package](https://badge.fury.io/py/apiai.svg)](http://badge.fury.io/py/apiai) +[![build](https://travis-ci.org/api-ai/api-ai-python.svg)](https://travis-ci.org/api-ai/api-ai-python) Overview @@ -25,10 +22,10 @@ Running examples 1. Find examples from 'examples' path. 2. Insert API key. -.. code-block:: python +```py >>> CLIENT_ACCESS_TOKEN = '' - ... +``` Features -------- @@ -42,24 +39,26 @@ Installation To install apiai, simply: -.. code-block:: bash +```bash $ pip install apiai - +``` or install it from repo: -.. code-block:: bash +```bash $ pip install https://github.com/api-ai/api-ai-python.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. In ubuntu the following will do the job: -.. code-block:: bash +```bash $ apt-get install python-pyaudio python-numpy $ pip install apiai +``` Documentation ------------- @@ -75,4 +74,4 @@ See [LICENSE](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/). -This is not an official Google product. \ No newline at end of file +This is not an official Google product.