openstack/python-zaqarclient
Code Issues Proposed changes

doc: Update README.rst with correct installation and contibution info

Browse Source 
Now that we are on PyPI, users can install from there. I also took
the opportunity to link to our new contributor guide.

Change-Id: Ifbdd07247a1e4865d02539f23be103c86414b7a9
This commit is contained in:
kgriffs 2014-06-10 17:23:30 -05:00
parent b9cd1104ed
commit f12c0aea60
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.rst
View File

@ -9,7 +9,7 @@ Python Marconi Client
:Design: `Client Wiki`_ :Design: `Client Wiki`_
:IRC: #openstack-marconi @ freenode :IRC: #openstack-marconi @ freenode
Welcome to the `Marconi`_ Client Python bindings project! Welcome to the `Marconi`_ Python Client project!
**Table of Contents** **Table of Contents**
@ -22,7 +22,11 @@ Welcome to the `Marconi`_ Client Python bindings project!
Installation Installation
============ ============
Until this project is on `PyPi`_, the official way to install these bindings are to:: The latest stable release can be installed from PyPI::
pip install --upgrade python-marconiclient
For the adventurous, you may also install the latest code directly from GitHub::
pip install git+https://github.com/openstack/python-marconiclient.git pip install git+https://github.com/openstack/python-marconiclient.git
@ -30,14 +34,12 @@ Until this project is on `PyPi`_, the official way to install these bindings are
Contributing Contributing
============ ============
The primary maintainer of this project is: TBA Be sure to reference the `HACKING`_ file for details on coding style. You may also wish to read through Marconi's `Contributor Guide`_ before contributing your first patch.
Be sure to reference the `HACKING`_ file for all the details.
.. _Marconi: https://github.com/openstack/marconi .. _Marconi: https://github.com/openstack/marconi
.. _PyPi: https://pypi.python.org
.. _HACKING: https://github.com/openstack/python-marconiclient/tree/master/HACKING.rst .. _HACKING: https://github.com/openstack/python-marconiclient/tree/master/HACKING.rst
.. _Marconi Wiki: https://wiki.openstack.org/wiki/Marconi .. _Marconi Wiki: https://wiki.openstack.org/wiki/Marconi
.. _Contributor Guide: https://wiki.openstack.org/wiki/Marconi#Contributor_Guide
.. _Marconi Launchpad: https://launchpad.net/marconi .. _Marconi Launchpad: https://launchpad.net/marconi
.. _Code Review: https://review.openstack.org/#/q/status:open+project:openstack/python-marconiclient,n,z .. _Code Review: https://review.openstack.org/#/q/status:open+project:openstack/python-marconiclient,n,z
.. _Client Wiki: https://wiki.openstack.org/wiki/Python_Marconi_Client .. _Client Wiki: https://wiki.openstack.org/wiki/Python_Marconi_Client