From 05ef7fc076e0ef214d15e6027da0e544c1fb7a8d Mon Sep 17 00:00:00 2001
From: Boris Pavlovic <boris@pavlovic.me>
Date: Thu, 1 Mar 2018 13:47:15 -0800
Subject: [PATCH] Add usage section to README

Change-Id: Id29ea00af667dac18e41014fb9e72e8816a5f9a1
---
 README.rst | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/README.rst b/README.rst
index d48f7af5..35f28a8d 100644
--- a/README.rst
+++ b/README.rst
@@ -4,6 +4,44 @@ rally-openstack
 
 Rally plugins for `OpenStack platform <https://openstack.org>`_
 
+
+Usage
+-----
+
+..code-block:: bash
+
+    # Install this package (will install rally if not installed)
+    pip install rally-openstack
+
+    # List all installed plugins
+    rally plugin --platform openstack
+
+    # Create OpenStack Env
+
+    cat <<EOT >> env.yaml
+    ---
+    openstack:
+      auth_url: "https://keystone.net/identity"
+      region_name: RegionOne
+      https_insecure: False
+      users:
+        - username: user_that_runs_commands
+          password: his password
+          project_name: project_that_users_belong_to
+    EOT
+
+    rally env create --name my_openstack --spec env.yml
+
+    # Check that you provide correct credentials
+    rally env check
+
+    # Collect key Open Stack metrics
+    rally task start ./tasks/openstack_metrics/task.yaml --task-args {"image_name": "image_to_use", "flavor_name": "flavor_to_use"}
+
+    # Generate Repot
+    rally task report --out report.html
+
+
 Links
 ----------------------