From 92243239ee33ee1eb40218d7dc5073ced3494891 Mon Sep 17 00:00:00 2001 From: ricolin Date: Thu, 15 Oct 2015 18:04:36 +0800 Subject: [PATCH] Improve readme contents Add more information in README.rst Change-Id: I09d90df7c2565fede3089ee185c181cc14f11442 --- README.rst | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 9800d05e..06a2134c 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,18 @@ Python bindings to the OpenStack Sahara API =========================================== +.. image:: https://img.shields.io/pypi/v/python-saharaclient.svg + :target: https://pypi.python.org/pypi/python-saharaclient/ + :alt: Latest Version + +.. image:: https://img.shields.io/pypi/dm/python-saharaclient.svg + :target: https://pypi.python.org/pypi/python-saharaclient/ + :alt: Downloads + This is a client for the OpenStack Sahara API. There's a Python API (the ``saharaclient`` module), and a command-line script (``sahara``). Each implements the OpenStack Sahara API. You can find documentation for both -Python bandings and CLI in `Docs`_. +Python bindings and CLI in `Docs`_. Development takes place via the usual OpenStack processes as outlined in the `developer guide @@ -13,6 +21,21 @@ in the `developer guide .. _Docs: http://docs.openstack.org/developer/python-saharaclient/ * License: Apache License, Version 2.0 -* Documentation: http://docs.openstack.org/developer/python-saharaclient -* Source: http://git.openstack.org/cgit/openstack/python-saharaclient -* Bugs: http://bugs.launchpad.net/python-saharaclient +* `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-saharaclient +.. _Online Documentation: http://docs.openstack.org/developer/python-saharaclient +.. _Launchpad project: https://launchpad.net/python-saharaclient +.. _Blueprints: https://blueprints.launchpad.net/python-saharaclient +.. _Bugs: https://bugs.launchpad.net/python-saharaclient +.. _Source: https://git.openstack.org/cgit/openstack/python-saharaclient +.. _How to Contribute: http://docs.openstack.org/infra/manual/developers.html +.. _Specs: http://specs.openstack.org/openstack/sahara-specs/ +