summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorricolin <rico.l@inwinstack.com>2015-10-15 17:38:25 +0800
committerRico Lin <rico.l@inwinstack.com>2016-01-03 10:06:39 +0000
commit2153b41a2ec31817d7f283a70b77b34b6dd498fe (patch)
tree2f75b770b1f48f7465c255178f18bd70d4c8f7c1 /README.rst
parentcfecd8ebe0c3baf259142615e94d698fc0b4169f (diff)
downloadpython-cinderclient-2153b41a2ec31817d7f283a70b77b34b6dd498fe.tar.gz
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
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst31
1 files changed, 26 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 2d90b8f..b024a43 100644
--- a/README.rst
+++ b/README.rst
@@ -1,6 +1,14 @@
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
``cinderclient`` module), and a command-line script (``cinder``). Each
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
+* 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:
:local:
@@ -150,8 +176,3 @@ Quick-start using keystone::
[...]
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