]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
Updated README with How-to-use instructions
authorBabu Shanmugam <anbu@enovance.com>
Fri, 24 Jan 2014 06:08:20 +0000 (06:08 +0000)
committerBabu Shanmugam <anbu@enovance.com>
Fri, 24 Jan 2014 06:08:20 +0000 (06:08 +0000)
README.md

index c028db7cd932e6ebbad1ace7ca93b90eef66d555..43772394acd0c5677138014edb675c28c3620ba0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,3 +7,13 @@ For more information please visit:
 
 * [Blueprint](http://wiki.ceph.com/Planning/Blueprints/Firefly/Ceph-Brag)
 * [CDS Etherpad](http://pad.ceph.com/p/cdsfirefly-ceph-brag)
+
+How to use:
+===========
+Pre-requisites:
+---------------
+ceph-brag uses 'ceph' python script. Hence, before executing ceph-brag script ensure that ceph services are all running and 'ceph' script is in 'PATH' environment
+
+Runtime instructions:
+---------------------
+Run 'ceph-brag -h' to get the usage information of this tool.