improve readme contents
Add more information in README.rst Add information link list as follow: * PyPi - package installation * Online Documentation * Blueprints - feature specifications * Bugs - issue tracking * Source * Specs * How to Contribute Change-Id: I818b6df38e73adf5963191dfff731110bcdb773a
This commit is contained in:
31
README.rst
31
README.rst
@@ -1,6 +1,14 @@
|
|||||||
Python bindings to the OpenStack Cinder API
|
Python bindings to the OpenStack Cinder API
|
||||||
===========================================
|
===========================================
|
||||||
|
|
||||||
|
.. image:: https://img.shields.io/pypi/v/python-cinderclient.svg
|
||||||
|
:target: https://pypi.python.org/pypi/python-cinderclient/
|
||||||
|
:alt: Latest Version
|
||||||
|
|
||||||
|
.. image:: https://img.shields.io/pypi/dm/python-cinderclient.svg
|
||||||
|
:target: https://pypi.python.org/pypi/python-cinderclient/
|
||||||
|
:alt: Downloads
|
||||||
|
|
||||||
This is a client for the OpenStack Cinder API. There's a Python API (the
|
This is a client for the OpenStack Cinder API. There's a Python API (the
|
||||||
``cinderclient`` module), and a command-line script (``cinder``). Each
|
``cinderclient`` module), and a command-line script (``cinder``). Each
|
||||||
implements 100% of the OpenStack Cinder API.
|
implements 100% of the OpenStack Cinder API.
|
||||||
@@ -26,6 +34,24 @@ python-cinderclient is licensed under the Apache License like the rest of OpenSt
|
|||||||
|
|
||||||
__ https://github.com/jacobian-archive/python-cloudservers
|
__ https://github.com/jacobian-archive/python-cloudservers
|
||||||
|
|
||||||
|
* License: Apache License, Version 2.0
|
||||||
|
* `PyPi`_ - package installation
|
||||||
|
* `Online Documentation`_
|
||||||
|
* `Blueprints`_ - feature specifications
|
||||||
|
* `Bugs`_ - issue tracking
|
||||||
|
* `Source`_
|
||||||
|
* `Specs`_
|
||||||
|
* `How to Contribute`_
|
||||||
|
|
||||||
|
.. _PyPi: https://pypi.python.org/pypi/python-cinderclient
|
||||||
|
.. _Online Documentation: http://docs.openstack.org/developer/python-cinderclient
|
||||||
|
.. _Blueprints: https://blueprints.launchpad.net/python-cinderclient
|
||||||
|
.. _Bugs: https://bugs.launchpad.net/python-cinderclient
|
||||||
|
.. _Source: https://git.openstack.org/cgit/openstack/python-cinderclient
|
||||||
|
.. _How to Contribute: http://docs.openstack.org/infra/manual/developers.html
|
||||||
|
.. _Specs: http://specs.openstack.org/openstack/cinder-specs/
|
||||||
|
|
||||||
|
|
||||||
.. contents:: Contents:
|
.. contents:: Contents:
|
||||||
:local:
|
:local:
|
||||||
|
|
||||||
@@ -150,8 +176,3 @@ Quick-start using keystone::
|
|||||||
[...]
|
[...]
|
||||||
|
|
||||||
See release notes and more at `<http://docs.openstack.org/developer/python-cinderclient/>`_.
|
See release notes and more at `<http://docs.openstack.org/developer/python-cinderclient/>`_.
|
||||||
|
|
||||||
* License: Apache License, Version 2.0
|
|
||||||
* Documentation: http://docs.openstack.org/developer/python-cinderclient
|
|
||||||
* Source: http://git.openstack.org/cgit/openstack/python-cinderclient
|
|
||||||
* Bugs: http://bugs.launchpad.net/python-cinderclient
|
|
||||||
|
Reference in New Issue
Block a user