Standalone mode is working again.

[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 fa0a063..5fc1be0 100644 (file)
--- a/src/emuvim/api/sonata/README.md
+++ b/src/emuvim/api/sonata/README.md
@@ -1,5 +1,18 @@
 # SONATA dummy gatekeeper API:
 
+## Requirements
+
+* uuid
+* hashlib
+* zipfile
+* yaml
+* docker-py
+* flask
+* flask_restful
+
+## Run REST API in standalone mode (without emulator):
+* `python src/emuvim/api/sonata/dummygatekeeper.py`
+
 ## Run emulator example with active SONATA dummy gatekeeper:
 The example starts a small network with two data centers.
 
@@ -82,6 +95,10 @@ _Note: This API should converge to the API of the original GK as much as possibl
 </table>
 
 
-## Run REST API in standalone mode (without emulator):
-This is not working yet!!!
-* `sudo python src/emuvim/api/sonata/dummygatekeeper.py`
\ No newline at end of file
+
+
+
+## Cleanup
+The dummy GK will store some files in your tmp folder in order to fake "catalogues" and "repositories" etc.
+
+* ` sudo rm -r /tmp/son-dummy-gk/`
\ No newline at end of file