Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken README #52

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md → README.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
api.ai: Python SDK for `API.AI <http://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
Expand All @@ -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 <http://api.ai>`_.


Running examples
--------
----------------

1. Find examples from 'examples' path.
2. Insert API key.
Expand Down Expand Up @@ -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.

Expand All @@ -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 <https://github.com/dialogflow/dialogflow-python-client/blob/master/CONTRIBUTING.md>`_.

## License
See [LICENSE](LICENSE).
See `LICENSE <https://github.com/dialogflow/dialogflow-python-client/blob/master/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 <https://developers.google.com/terms/>`_.

This is not an official Google product.