From 9ce4f345d1fb861d872a86e4c0ccd85d4a445d2b Mon Sep 17 00:00:00 2001
From: Catherine Diep <cdiep@us.ibm.com>
Date: Wed, 30 Jul 2014 18:03:29 -0700
Subject: [PATCH] Update the README file.

Add testing instructions to the README file.  Also add the missing
gitreview file.

Change-Id: Ia670c83b4d832522eee8716fe97a648f69810189
---
 .gitreview |  4 ++++
 README.rst | 37 +++++++++++++++++++++++++++++++------
 2 files changed, 35 insertions(+), 6 deletions(-)
 create mode 100644 .gitreview

diff --git a/.gitreview b/.gitreview
new file mode 100644
index 0000000..a470f93
--- /dev/null
+++ b/.gitreview
@@ -0,0 +1,4 @@
+[gerrit]
+host=review.openstack.org
+port=29418
+project=stackforge/refstack-client.git
diff --git a/README.rst b/README.rst
index 83044ff..047fc3b 100644
--- a/README.rst
+++ b/README.rst
@@ -1,12 +1,37 @@
 refstack-client
 ===============
 
-refstack-client test is a command line utility that allows you to execute tempest runs a config you specify. When finished running tempest it sends the passed test data back to the refstack api. 
+refstack-client is a command line utility that allows you to execute Tempest
+test runs based on configurations you specify.  When finished running Tempest
+it sends the passed test data back to the Refstack API server.
 
-**Usage (ubuntu)** 
+**Usage (Ubuntu)**
 
-We've created an "easy button" for ubuntu. 
-	
-	$ sh ./setup_ubuntu_env.sh
+We've created an "easy button" for Ubuntu.
 
-## TODO finish this once code is in a working state
\ No newline at end of file
+$ sh ./setup_ubuntu_env.sh
+
+**Start testing**
+
+1. Prepare a tempest configuration file that is customized to your cloud
+   environment.
+2. Change the directory to the refstack-client directory
+   (i.e. cd ~/refstack-client).
+3. Source to use the correct Python environment.
+
+   source test_runner/bin/activate
+
+4. Execute test by typing:
+
+   refstack-client/refstack-client -c "Path of the tempest configuration file\
+   to use"
+
+   **Note:**
+
+   a. Adding -v option will show the summary output.
+   b. Adding -vv option will show the Tempest test result output.
+   c. Adding -t option will only test a particular test case or a test group.
+      This option can be used for quick verification of the target test cases
+      (i.e. -t "tempest.api.identity.admin.test_roles").
+   d. Adding --url option will upload the test results to a Refstack API server
+      instead of the default Refstack API server.