Merge pull request #133 from mpeuster/master

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

diff --git a/README.md b/README.md
index 2e2c703..68f9fab 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ This emulation platform was created to support network  service developers to lo
 
 More details about the the emulator's architecture and concepts can be found in the following publication(s):
 
-* Peuster, Manuel, Holger Karl, and Steven van Rossem. ["MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments."](http://arxiv.org/abs/1606.05995) pre-print arXiv:1606.05995 (2016).
+* Manuel Peuster, Holger Karl, and Steven van Rossem. ["MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments."](http://arxiv.org/abs/1606.05995) pre-print arXiv:1606.05995 (2016).
 
 A short demo that showcases son-emu together with its dummy gatekeeper is available [here](https://youtu.be/BgWDp5CM0io).
 
@@ -19,18 +19,18 @@ To install the emulator package in development mode, do:
 
 #### Folder Structure
 
-* `ansible`
-* `misc`
+* `ansible` Install scripts
+* `misc` Example packages and VNFs
 * `src` 
- * `emuvim`
-  * `api`
-   * `rest` REST API for son-emu-cli
-   * `sonata` Dummy gatekeeper API
-  * `cli` Command line client to control the emulator
-  * `dcemulator` Emulator core
-   * `resourcemodel` Resource limitation models
-  * `examples` Example topology scripts
-  * `test` Test scripts
+       * `emuvim` Emulator components
+               * `api` API endpoint implementations
+                       * `rest` REST API for son-emu-cli
+               * `sonata` Dummy gatekeeper API
+               * `cli` Command line client to control the emulator
+               * `dcemulator` Emulator core
+                       * `resourcemodel` Resource limitation models
+       * `examples` Example topology scripts
+       * `test` Test scripts
 * `utils` Helper scripts for SONATA's CI/CD setup
 
 
@@ -138,6 +138,8 @@ This example shows how to deploy a SONATA example package in the emulator using
  * Instantiate: `curl -X POST http://127.0.0.1:5000/instantiations -d "{}"`
  * Verify that service runs: `son-emu-cli compute list`
 
+Note: The [son-push](https://github.com/mpeuster/son-cli) tool can be used instead of CURL.
+
 
 ### CLI Commands
 * [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)
@@ -161,4 +163,4 @@ The following lead developers are responsible for this repository and have admin
 #### Feedback-Chanel
 
 * You may use the mailing list [sonata-dev@lists.atosresearch.eu](mailto:sonata-dev@lists.atosresearch.eu)
-* * [GitHub issues](https://github.com/sonata-nfv/son-emu/issues)
+* [GitHub issues](https://github.com/sonata-nfv/son-emu/issues)