improve readme contents

Add more information in README.rst

Change-Id: Iae60a780828015c6a5919405cdcd31010b386d26
This commit is contained in:
ricolin 2015-10-15 17:49:39 +08:00 committed by Rico Lin
parent e4ced578b2
commit 5f079feeaf

View File

@ -1,14 +1,31 @@
Python bindings to the Neutron API
==================================
.. image:: https://img.shields.io/pypi/v/python-neutronclient.svg
:target: https://pypi.python.org/pypi/python-neutronclient/
:alt: Latest Version
.. image:: https://img.shields.io/pypi/dm/python-neutronclient.svg
:target: https://pypi.python.org/pypi/python-neutronclient/
:alt: Downloads
This is a client library for Neutron built on the Neutron API. It
provides a Python API (the ``neutronclient`` module) and a command-line tool
(``neutron``).
Development takes place via the usual OpenStack processes as outlined in the
`developer guide <http://docs.openstack.org/infra/manual/developers.html>`_.
* License: Apache License, Version 2.0
* Documentation: http://docs.openstack.org/developer/python-neutronclient
* Source: http://git.openstack.org/cgit/openstack/python-neutronclient
* Bugs: http://bugs.launchpad.net/python-neutronclient
* `PyPi`_ - package installation
* `Online Documentation`_
* `Launchpad project`_ - release management
* `Blueprints`_ - feature specifications
* `Bugs`_ - issue tracking
* `Source`_
* `Developer's Guide`_
.. _PyPi: https://pypi.python.org/pypi/python-neutronclient
.. _Online Documentation: http://docs.openstack.org/developer/python-neutronclient
.. _Launchpad project: https://launchpad.net/python-neutronclient
.. _Blueprints: https://blueprints.launchpad.net/python-neutronclient
.. _Bugs: https://bugs.launchpad.net/python-neutronclient
.. _Source: https://git.openstack.org/cgit/openstack/python-neutronclient
.. _Developer's Guide: http://docs.openstack.org/infra/manual/developers.html