Restructured to re-enable GK standalone mode.

[osm/vim-emu.git] / src / emuvim / api / sonata / README.md

diff --git a/src/emuvim/api/sonata/README.md b/src/emuvim/api/sonata/README.md
index b867965..e3269aa 100644 (file)
--- a/src/emuvim/api/sonata/README.md
+++ b/src/emuvim/api/sonata/README.md
@@ -1,5 +1,20 @@
 # SONATA dummy gatekeeper API:
 
+## Requirements
+
+* uuid
+* hashlib
+* zipfile
+* yaml
+* docker-py
+* flask
+* flask_restful
+
+## Run emulator example with active SONATA dummy gatekeeper:
+The example starts a small network with two data centers.
+
+* `sudo python src/emuvim/examples/sonata_y1_demo_topology_1.py`
+
 ## Upload a package (*.son) file:
 
 To upload the file `sonata-demo.son` (from son-schema repo) do:
@@ -76,10 +91,7 @@ _Note: This API should converge to the API of the original GK as much as possibl
 </tr>
 </table>
 
-## Run REST API as part of the emulator:
-
-* `sudo python src/emuvim/examples/sonata_y1_demo_topology_1.py`
 
 ## Run REST API in standalone mode (without emulator):
-
-* `sudo python src/emuvim/api/sonata/dummygatekeeper.py`
\ No newline at end of file
+This is not working yet!!!
+* `python src/emuvim/api/sonata/dummygatekeeper.py`
\ No newline at end of file