improve readme contents

Add more information in README.rst

Change-Id: I843b850702606102cbb6a6a6ec47fd90b92704f6
This commit is contained in:
ricolin 2015-10-15 17:45:46 +08:00
parent 2fcff11b90
commit b51634a609
1 changed files with 26 additions and 3 deletions

View File

@ -1,6 +1,14 @@
Python bindings to the OpenStack Images API
=============================================
.. image:: https://img.shields.io/pypi/v/python-glanceclient.svg
:target: https://pypi.python.org/pypi/python-glanceclient/
:alt: Latest Version
.. image:: https://img.shields.io/pypi/dm/python-glanceclient.svg
:target: https://pypi.python.org/pypi/python-glanceclient/
:alt: Downloads
This is a client library for Glance built on the OpenStack Images API. It provides a Python API (the ``glanceclient`` module) and a command-line tool (``glance``). This library fully supports the v1 Images API, while support for the v2 API is in progress.
Development takes place via the usual OpenStack processes as outlined in the `developer guide <http://docs.openstack.org/infra/manual/developers.html>`_. The master repository is in `Git <https://git.openstack.org/cgit/openstack/python-glanceclient>`_.
@ -8,6 +16,21 @@ Development takes place via the usual OpenStack processes as outlined in the `de
See release notes and more at `<http://docs.openstack.org/developer/python-glanceclient/>`_.
* License: Apache License, Version 2.0
* Documentation: http://docs.openstack.org/developer/python-glanceclient
* Source: http://git.openstack.org/cgit/openstack/python-glanceclient
* Bugs: http://bugs.launchpad.net/python-glanceclient
* `PyPi`_ - package installation
* `Online Documentation`_
* `Launchpad project`_ - release management
* `Blueprints`_ - feature specifications
* `Bugs`_ - issue tracking
* `Source`_
* `Specs`_
* `How to Contribute`_
.. _PyPi: https://pypi.python.org/pypi/python-glanceclient
.. _Online Documentation: http://docs.openstack.org/developer/python-glanceclient
.. _Launchpad project: https://launchpad.net/python-glanceclient
.. _Blueprints: https://blueprints.launchpad.net/python-glanceclient
.. _Bugs: https://bugs.launchpad.net/python-glanceclient
.. _Source: https://git.openstack.org/cgit/openstack/python-glanceclient
.. _How to Contribute: http://docs.openstack.org/infra/manual/developers.html
.. _Specs: http://specs.openstack.org/openstack/glance-specs/