cleanup for open sourcing
[osm/vim-emu.git] / README.md
index 81f3f20..963aec1 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -19,11 +19,11 @@ To install the emulator package in development mode, do:
 
 #### Folder Structure
 
-* `ansible`
-* `misc`
+* `ansible` Install scripts
+* `misc` Example packages and VNFs
 * `src` 
-       * `emuvim`
-               * `api`
+       * `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
@@ -55,7 +55,6 @@ Despite of this son-emu has the following dependencies:
 * [flask_restful](https://pypi.python.org/pypi/Flask-RESTful) >= 0.3 (BSD)
 * [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11  (BSD)
 * [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0  (Apache 2.0)
-* [paramiko](https://pypi.python.org/pypi/paramiko/1.16.0) >= 1.6 (LGPL)
 * [prometheus_client](https://pypi.python.org/pypi/prometheus_client) >= 0.0.13 (Apache 2.0)
 * [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL)
 * [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT)
@@ -68,7 +67,7 @@ Despite of this son-emu has the following dependencies:
 * [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT)
 
 ### Contributing
-Contributing to the Gatekeeper is really easy. You must:
+Contributing to the son-emu is really easy. You must:
 
 1. Clone [this repository](http://github.com/sonata-nfv/son-emu);
 2. Work on your proposed changes, preferably through submiting [issues](https://github.com/sonata-nfv/son-emu/issues);
@@ -163,4 +162,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)