added basic API registration and connection mechanism

[osm/vim-emu.git] / README.md

diff --git a/README.md b/README.md
index 0ee1d9e..63ed10e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,11 +5,18 @@
 
 ## emu-vim
 
+### Requirements
+* needs the latest Dockernet to be installed in the system
+ * the wrapper uses standard Python imports to use the Dockernet modules
+* Uses ZeroMQ based RPC to open a cloud-like interface that can be used by a demo CLI client
+ * pip install import zerorpc
+ * This will be replaced / extended by a REST API later
+
 ### TODO
 
 * Add runtime API
-** call startAPI from topology definition and start it in a own thread?
-** make it possible to start different API endpoints for different DCs?
+ * call startAPI from topology definition and start it in a own thread?
+ * make it possible to start different API endpoints for different DCs?
 * Add resource constraints to datacenters
 * Add constraints to Links
 * Check if we can use the Mininet GUI to visualize our DCs?
\ No newline at end of file