openstack
/
python-saharaclient
Code Issues Proposed changes

Improve readme contents 

Add more information in README.rst

Change-Id: I09d90df7c2565fede3089ee185c181cc14f11442
This commit is contained in:
ricolin 2015-10-15 18:04:36 +08:00
parent 8c8b650cca
commit 92243239ee
1 changed files with 27 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.rst
View File

@ -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/