From 1794c29ebcd5b49faccb76dba7d5339187fbf696 Mon Sep 17 00:00:00 2001
From: Ramakrishnan G <rameshg87@gmail.com>
Date: Mon, 27 Jul 2015 01:57:21 -0700
Subject: [PATCH] Update documentation

Update the documentation README.rst file with proper
formatting and more links.

Change-Id: Ic106b588a0edf75c9a8a1f8473c29a6ebd945a92
---
 README.rst | 43 +++++++++++++++++++++++++++++++++----------
 1 file changed, 33 insertions(+), 10 deletions(-)

diff --git a/README.rst b/README.rst
index 00f996d..ad9e189 100644
--- a/README.rst
+++ b/README.rst
@@ -1,17 +1,40 @@
+proliantutils
+=============
 
-==============
-Proliant Utils
-==============
+**proliantutils** is a set of utility libraries for interfacing and managing
+various components (like iLO, HPSSA) for HP Proliant Servers.  This library
+is used by iLO drivers in Ironic for managing Proliant Servers (though the
+library can be used by anyone who wants to manage HP Proliant servers).
 
-Proliant Management Tools provides python libraries for interfacing and 
-managing various devices(like iLO) present in HP Proliant Servers.
+Please use launchpad_ to report bugs and ask questions.
 
-Currently, this module offers a library to interface to iLO4 using RIBCL.
+.. _launchpad: https://bugs.launchpad.net/proliantutils
 
-#!/usr/bin/python
+Installation
+------------
 
-    from proliantutils.ilo import ribcl
+Install the module from PyPI_.  If you are using Ironic, install the module
+on Ironic conductor node::
 
-    ilo_client = ribcl.IloClient('1.2.3.4', 'Administrator', 'password')
-    print ilo_client.get_host_power_status()
+  pip install proliantutils
 
+.. _PyPI: https://pypi.python.org/pypi/proliantutils
+
+Some GNU/Linux distributions provide *python-proliantutils* package.
+
+Usage
+-----
+
+iLO
+~~~
+
+For interfacing with the iLO, use *IloClient* object::
+
+  >>> from proliantutils.ilo import client
+  >>> ilo_client = client.IloClient('10.10.1.57', 'Administrator', 'password')
+  >>> ilo_client.get_host_power_status()
+  'OFF'
+  >>>
+
+For operations supported on the client object, please refer
+*proliantutils.ilo.operations*.