summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorricolin <rico.l@inwinstack.com>2015-10-15 18:12:55 +0800
committerricolin <rico.l@inwinstack.com>2015-10-16 14:36:30 +0800
commite65611ff870dead5d67236f4ad61b9abbe6c8ffb (patch)
treeffcb646d65787b0c8f07ad09ba34e601fd36eadd /README.rst
parent6e995794b44e053ec751c25221c16ac25d01fed9 (diff)
downloadpython-barbicanclient-e65611ff870dead5d67236f4ad61b9abbe6c8ffb.tar.gz
improve readme contents
Add more information in README.rst Change-Id: I9a92a85b9760da62b9507e67daee3fdf257683a8
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst29
1 files changed, 26 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index 5bf0a59..ff3c12f 100644
--- a/README.rst
+++ b/README.rst
@@ -1,6 +1,14 @@
python-barbicanclient
=====================
+.. image:: https://img.shields.io/pypi/v/python-barbicanclient.svg
+ :target: https://pypi.python.org/pypi/python-barbicanclient/
+ :alt: Latest Version
+
+.. image:: https://img.shields.io/pypi/dm/python-barbicanclient.svg
+ :target: https://pypi.python.org/pypi/python-barbicanclient/
+ :alt: Downloads
+
This is a client for the `Barbican <https://github.com/openstack/barbican>`__
Key Management API. There is a Python library for accessing the API
(`barbicanclient` module), and a command-line script (`barbican`).
@@ -184,9 +192,24 @@ usage options
secret update Update a secret with no payload in Barbican.
* License: Apache License, Version 2.0
-* Documentation: http://docs.openstack.org/developer/python-barbicanclient
-* Source: http://git.openstack.org/cgit/openstack/python-barbicanclient
-* Bugs: http://bugs.launchpad.net/python-barbicanclient
+* `PyPi`_ - package installation
+* `Online Documentation`_
+* `Launchpad project`_ - release management
+* `Blueprints`_ - feature specifications
+* `Bugs`_ - issue tracking
+* `Source`_
+* `Specs`_
+* `Getting involved`_
+
+.. _PyPi: https://pypi.python.org/pypi/python-barbicanclient/
+.. _Online Documentation: http://docs.openstack.org/developer/python-barbicanclient/
+.. _Launchpad project: https://launchpad.net/python-barbicanclient/
+.. _Blueprints: https://blueprints.launchpad.net/python-barbicanclient/
+.. _Bugs: https://bugs.launchpad.net/python-barbicanclient/
+.. _Source: https://git.openstack.org/cgit/openstack/python-barbicanclient/
+.. _Getting involved: http://docs.openstack.org/developer/barbican/contribute/getting_involved.html
+.. _Specs: http://specs.openstack.org/openstack/barbican-specs/
+
.. [1] Documentation in this link is currently incomplete. Please use the
`devstack setup. <http://docs.openstack.org/developer/barbican/setup/devstack.html>`__