Fixup README

To be able to make a release README.rst should follow some
convention.

This change fixes that.

Change-Id: Ib4d1fd628bb0374586146b11dfafa0b243b3f084
This commit is contained in:
Mehdi Abaakouk 2018-06-14 14:34:08 +02:00
parent 6002b08818
commit 6d1ad0fba7

View File

@ -1,15 +1,17 @@
=============
==========
aodhclient
=============
==========
Python bindings to the OpenStack Aodh API
This is a client for OpenStack Aodh API. There's :doc:`a Python API
<api>` (the :mod:`aodhclient` module), and a :doc:`command-line script
<shell>` (installed as :program:`aodh`). Each implements the entire
OpenStack Aodh API.
This is a client for OpenStack Aodh API. There's a `Python API
<https://docs.openstack.org/python-aodhclient/latest/api.html>`_ (the
aodhclient module), and a `command-line script
<https://docs.openstack.org/python-aodhclient/latest/shell.html>`_ (installed
as aodh). Each implements the entire OpenStack Aodh API.
* Free software: Apache license
* Release notes: https://releases.openstack.org/teams/telemetry.html
* Documentation: https://docs.openstack.org/python-aodhclient/latest/
* Source: https://git.openstack.org/cgit/openstack/python-aodhclient
* Bugs: https://bugs.launchpad.net/python-aodhclient