From 964dd4e88d665c566dfce15f2b7ebd2dc14e3e18 Mon Sep 17 00:00:00 2001
From: Nikolay Mahotkin <nmakhotkin@mirantis.com>
Date: Mon, 8 Dec 2014 18:22:59 +0300
Subject: [PATCH] Add mistralclient documentation

Change-Id: Ia269ac6c8811e8db34a657283b2839d3f2feeba6
---
 README.md | 45 ++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 42 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index eef9d91c..944849e2 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,43 @@
-python-mistralclient
-====================
+Mistral client
+==============
 
-Python client for Mistral REST API
+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 https://github.com/stackforge/python-mistralclient.git
+    cd python-mistralclient
+
+Then just run:
+
+    pip install -e .
+
+or
+
+    python setup.py install
+
+
+Running Mistral client
+----------------------
+
+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 default URL=http://localhost:8989/v2)
+
+>***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
+
+You can see the list of available commands typing:
+
+    mistral --help