Update Quantum README file with instructions to launch the service and get going.

diff --git a/README b/README
index e09f1ab8a746d3741613d83947757f5620bbb079..799d05f303ceda9b81889fd6b6859eb1aceb4dc0 100644 (file)
--- a/README
+++ b/README
@@ -17,13 +17,63 @@
    b) Allows Quantum users to not be tied down to a single Quantum implementation and
       enables them to switch out a plug-in by simple editing a config file - plugins.ini
 
+
 # -- Configuring Quantum plug-in
 
+1) Explore sample and real Quantum plug-ins in the quantum.plugins module.
+
+2) Or copy another Quantum plug-in into the quantum.plugins module.
+
+3) Update plug-in configuration by editing plugins.ini file and modify
+   "provider" property to point to the location of the Quantum plug-in.
+   
+4) Read the plugin specific README, this is usually found in the same 
+   directory as your Quantum plug-in, and follow configuration instructions.
+    
 # -- Launching the Quantum Service
 
+1) Start quantum using the following command [on the quantum service host]:
+~/src/quantum$ PYTHONPATH=.:$PYTHONPATH python bin/quantum etc/quantum.conf
+
 # -- Making requests against the Quantum Service
 
-# -- CLI tools to program the Quantum-managed network fabric
+Please refer to sample Web Service client code in:
+
+../quantum/test_scripts/miniclient.py
+
+# -- CLI tools to program the Quantum-managed Cloud networking fabric
+
+Quantum comes with a programmatic CLI that is driven by the Quantum Web Service
+You can use the CLI by issuing the following command:
+
+~/src/quantum$ PYTHONPATH=.:$PYTHONPATH python quantum/cli.py
+
+This will show help all of the available commands.
+
+An example session looks like this:
+
+$ export TENANT=t1
+$ PYTHONPATH=. python quantum/cli.py -v create_net $TENANT network1
+Created a new Virtual Network with ID:e754e7c0-a8eb-40e5-861a-b182d30c3441
 
 # -- Writing your own Quantum plug-in
+
+If you wish the write your own Quantum plugin, please refer to some concrete as
+well as sample plugins available in:
+
+../quantum/quantum/plugins/.. directory.
+
+There are a few requirements to writing your own plugin:
+
+1) Your plugin should implement all methods defined in 
+../quantum/quantum/quantum_plugin_base.QuantumPluginBase class
+
+2) Copy your Quantum plug-in over to the ../quantum/quantum/plugins/.. directory
+
+3) The next step is to edit the plugins.ini file in the same directory
+   as QuantumPluginBase class and specify the location of your custom plugin
+   as the "provider"
+
+4) Launch the Quantum Service, and your plug-in is configured and ready to manage
+   a Cloud Networking Fabric.
  
\ No newline at end of file