Added a basic README file and updated Quantum plugin base class with appropriate...

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..e09f1ab
--- /dev/null
+++ b/README
@@ -0,0 +1,29 @@
+# -- Welcome!
+
+  You have come across a cloud computing network fabric controller.  It has identified
+  itself as "Quantum."  It aims to tame your (cloud) networking!
+  
+# -- Basics:
+
+1) Quantum REST API: Quantum supports a REST-ful programmatic interface to manage your
+   cloud networking fabric.
+
+2) Quantum Plugins: Quantum sports a plug-able architecture that allows Quantum's REST API
+   to be backed by various entities that can create a cloud-class virtual networking fabric.
+   The advantages of this plug-able architecture is two-folds:
+   
+   a) Allows for ANY open-source project or commercial vendor to write a Quantum plug-in.
+   
+   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
+
+# -- Launching the Quantum Service
+
+# -- Making requests against the Quantum Service
+
+# -- CLI tools to program the Quantum-managed network fabric
+
+# -- Writing your own Quantum plug-in
+ 
\ No newline at end of file

diff --git a/quantum/quantum_plugin_base.py b/quantum/quantum_plugin_base.py
index bf2976ec62cd4ef070ce2f835d14479f0bdd61eb..843bc85c5ca157954fe8cb52c73ca277712adb5a 100644 (file)
--- a/quantum/quantum_plugin_base.py
+++ b/quantum/quantum_plugin_base.py
@@ -37,7 +37,7 @@ class QuantumPluginBase(object):
         the specified tenant.
         
         :returns:
-        :raises:
+        :raises: None
         """
         pass