openstack/python-mistralclient
Code Issues Proposed changes

Make README better

Browse Source 
There are few places like https://github.com/openstack/python-mistralclient#running-mistral-client
in the README where the commands in the block are clumpsy. This
patch makes the commands look better.

Change-Id: I1caa538b7f182dc1e1afcd1ace285b1d16de299c
This commit is contained in:
Sharat Sharma 2017-07-25 18:17:12 +05:30
parent 6696c55574
commit 753a04c9d7
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.rst
View File

@ -37,16 +37,16 @@ Command Line Interface (CLI) library.
Installation Installation
------------ ------------
First of all, clone the repo and go to the repo directory: First of all, clone the repo and go to the repo directory::
$ git clone git://git.openstack.org/openstack/python-mistralclient.git $ git clone git://git.openstack.org/openstack/python-mistralclient.git
$ cd python-mistralclient $ cd python-mistralclient
Then just run: Then just run::
$ pip install -e . $ pip install -e .
or or::
$ pip install -r requirements.txt $ pip install -r requirements.txt
$ python setup.py install $ python setup.py install
@ -56,7 +56,7 @@ Running Mistral client
---------------------- ----------------------
If Mistral authentication is enabled, provide the information about OpenStack If Mistral authentication is enabled, provide the information about OpenStack
auth to environment variables. Type: auth to environment variables. Type::
$ export OS_AUTH_URL=http://<Keystone_host>:5000/v2.0 $ export OS_AUTH_URL=http://<Keystone_host>:5000/v2.0
$ export OS_USERNAME=admin $ export OS_USERNAME=admin
@ -72,11 +72,11 @@ and in the case that you are authenticating against keystone over https:
.. note:: In client, we can use both Keystone auth versions - v2.0 and v3. But .. note:: In client, we can use both Keystone auth versions - v2.0 and v3. But
server supports only v3.* server supports only v3.*
To make sure Mistral client works, type: To make sure Mistral client works, type::
$ mistral workbook-list $ mistral workbook-list
You can see the list of available commands typing: You can see the list of available commands typing::
$ mistral --help $ mistral --help