X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=src%2Femuvim%2Fapi%2Fsonata%2FREADME.md;h=5fc1be0721bb5cea275e5ee14c62132852cbb1c4;hb=92237dc0bc0a724210453c2e10445f8d6f68b06c;hp=b8679653b27624059ddedd3c077c9509e09e3c86;hpb=64b4550b56d1d20627e0c5f715449c665ec79c84;p=osm%2Fvim-emu.git

diff --git a/src/emuvim/api/sonata/README.md b/src/emuvim/api/sonata/README.md
index b867965..5fc1be0 100644
--- a/src/emuvim/api/sonata/README.md
+++ b/src/emuvim/api/sonata/README.md
@@ -1,5 +1,23 @@
 # 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.
+
+* `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 +94,11 @@ _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
+
+## 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