From e65611ff870dead5d67236f4ad61b9abbe6c8ffb Mon Sep 17 00:00:00 2001 From: ricolin Date: Thu, 15 Oct 2015 18:12:55 +0800 Subject: [PATCH] improve readme contents Add more information in README.rst Change-Id: I9a92a85b9760da62b9507e67daee3fdf257683a8 --- README.rst | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 5bf0a59e..ff3c12f2 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 `__ 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. `__