From e182978e4fc02a028fc8f089f013b6af42f101ac Mon Sep 17 00:00:00 2001
From: Sharat Sharma <sharat.sharma@nectechnologies.in>
Date: Mon, 16 Jan 2017 02:56:22 +0530
Subject: [PATCH] Changed the README.rst

Some useful links were missing from the README file which
would be useful for the first timers. So, adding those links
into the file.

Change-Id: Iac89fed65190084878aeac93987cd857793c9424
Partial-Implements: blueprint mistral-python-client-docs
---
 README.rst | 75 +++++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 58 insertions(+), 17 deletions(-)

diff --git a/README.rst b/README.rst
index f2e71ba6..385fe58c 100644
--- a/README.rst
+++ b/README.rst
@@ -5,55 +5,96 @@ Team and repository tags
 .. image:: http://governance.openstack.org/badges/python-mistralclient.svg
     :target: http://governance.openstack.org/reference/tags/index.html
 
-.. Change things from this point on
+Mistral
+=======
+
+.. image:: https://img.shields.io/pypi/v/python-mistralclient.svg
+    :target: https://pypi.python.org/pypi/python-mistralclient/
+    :alt: Latest Version
+
+.. image:: https://img.shields.io/pypi/dm/python-mistralclient.svg
+    :target: https://pypi.python.org/pypi/python-mistralclient/
+    :alt: Downloads
+
+Mistral is a workflow service. Most business processes consist of multiple
+distinct interconnected steps that need to be executed in a particular
+order in a distributed environment. A user can describe such a process as a set
+of tasks and their transitions. After that, it is possible to upload such a
+description to Mistral, which will take care of state management, correct
+execution order, parallelism, synchronization and high availability.
+
+Mistral also provides flexible task scheduling so that it can run a process
+according to a specified schedule (for example, every Sunday at 4.00pm) instead
+of running it immediately. In Mistral terminology such a set of tasks and
+relations between them is called a workflow.
 
 Mistral client
 ==============
 
-Python client for Mistral REST API. Includes python library for Mistral API and Command Line Interface (CLI) library.
-
+Python client for Mistral REST API. Includes python library for Mistral API and
+Command Line Interface (CLI) library.
 
 Installation
 ------------
 
 First of all, clone the repo and go to the repo directory:
 
-    | git clone git://git.openstack.org/openstack/python-mistralclient.git
-    | cd python-mistralclient
+    $ git clone git://git.openstack.org/openstack/python-mistralclient.git
+    $ cd python-mistralclient
 
 Then just run:
 
-    pip install -e .
+    $ pip install -e .
 
 or
 
-    | pip install -r requirements.txt
-    | python setup.py install
+    $ pip install -r requirements.txt
+    $ python setup.py install
 
 
 Running Mistral client
 ----------------------
 
-If Mistral authentication is enabled, provide the information about OpenStack auth to environment variables. Type:
+If Mistral authentication is enabled, provide the information about OpenStack
+auth to environment variables. Type:
 
-    | export OS_AUTH_URL=http://<Keystone_host>:5000/v2.0
-    | export OS_USERNAME=admin
-    | export OS_TENANT_NAME=tenant
-    | export OS_PASSWORD=secret
-    | export OS_MISTRAL_URL=http://<Mistral host>:8989/v2  (optional, by
+    $ export OS_AUTH_URL=http://<Keystone_host>:5000/v2.0
+    $ export OS_USERNAME=admin
+    $ export OS_TENANT_NAME=tenant
+    $ export OS_PASSWORD=secret
+    $ export OS_MISTRAL_URL=http://<Mistral host>:8989/v2  (optional, by
       default URL=http://localhost:8989/v2)
 
 and in the case that you are authenticating against keystone over https:
 
-    export OS_CACERT=<path_to_ca_cert>
+    $ export OS_CACERT=<path_to_ca_cert>
 
 .. note:: In client, we can use both Keystone auth versions - v2.0 and v3. But
           server supports only v3.*
 
 To make sure Mistral client works, type:
 
-    mistral workbook-list
+    $ mistral workbook-list
 
 You can see the list of available commands typing:
 
-    mistral --help
+    $ mistral --help
+
+Useful Links
+============
+
+* `PyPi`_ - package installation
+* `Launchpad project`_ - release management
+* `Blueprints`_ - feature specifications
+* `Bugs`_ - issue tracking
+* `Source`_
+* `Specs`_
+* `How to Contribute`_
+
+.. _PyPi: https://pypi.python.org/pypi/python-mistralclient
+.. _Launchpad project: https://launchpad.net/python-mistralclient
+.. _Blueprints: https://blueprints.launchpad.net/python-mistralclient
+.. _Bugs: https://bugs.launchpad.net/python-mistralclient
+.. _Source: https://git.openstack.org/cgit/openstack/python-mistralclient
+.. _How to Contribute: http://docs.openstack.org/infra/manual/developers.html
+.. _Specs: http://specs.openstack.org/openstack/mistral-specs/