Edits to README

README.md

@@ -1,13 +1,13 @@
-[![Build Status](https://api.travis-ci.org/ebu/ebu-tt-live-toolkit.svg?branch=master)](https://travis-ci.org/ebu/ebu-tt-live-toolkit) 
+[![Build Status](https://api.travis-ci.org/ebu/ebu-tt-live-toolkit.svg?branch=master)](https://travis-ci.org/ebu/ebu-tt-live-toolkit)
 [![Coverage Status](https://coveralls.io/repos/github/ebu/ebu-tt-live-toolkit/badge.svg?branch=ebu_master)](https://coveralls.io/github/ebu/ebu-tt-live-toolkit?branch=ebu_master)
 
 # ebu-tt-live-toolkit
 
-This is the repository for the interoperability kit of [EBU-TT Live](https://tech.ebu.ch/publications/tech3370). 
+This is the repository for the interoperability kit of [EBU-TT Live](https://tech.ebu.ch/publications/tech3370).
 
 The kit is envisaged to contain a set of components for generating, testing and distributing subtitle documents in EBU-TT Part 3 format.
 
-This is an open source project. Anyone is welcome to contribute to the development of the components. Please see the [wiki](https://github.com/ebu/ebu-tt-live-toolkit/wiki) for the list of required components, guidelines and release plan. 
+This is an open source project. Anyone is welcome to contribute to the development of the components. Please see the [wiki](https://github.com/ebu/ebu-tt-live-toolkit/wiki) for the list of required components, guidelines and release plan.
 
 The project home page is at [http://ebu.github.io/ebu-tt-live-toolkit/](http://ebu.github.io/ebu-tt-live-toolkit/) and links to the pre-built documentation.
 
@@ -56,11 +56,11 @@ After this you are supposed to be able to launch the command line tools this pyt
 provides i.e.:
 
     ebu-dummy-encoder
-    
+
 Windows users
 =============
 
-Windows is not the best friend of Makefiles. So there is a make.bat file for those who would like to develop using 
+Windows is not the best friend of Makefiles. So there is a make.bat file for those who would like to develop using
 Windows. Assuming python 2.7 and virtualenv is installed and are on the PATH. To build the project you will also need node.js. Please read the instructions for your system [here](https://nodejs.org/en/download/package-manager/). Then run :
 
     make
@@ -88,24 +88,23 @@ the changes.
 Scripts
 =======
 
-There are several scripts that emulate different components in the infrastructure. Assuming the Makefile worked,
-the package is installed in a virtual environment and the virtual environment is active the following scripts should
-be available directly from the command line.
+There are several scripts that emulate different components (nodes) in the infrastructure. They can be executed individually or in combinations by running `ebu-run`. Assuming the Makefile worked, the package is installed in a virtual environment and the virtual environment is active, the components should be available by running the `ebu-run` script and passing a configuration file. There are several example configuration files in `examples/config`. For the complete list see of scripts see `docs/build/html/scripts_and_their_functions.html`.
+
+Below is a list of some of the key components. .
 
-The simple producer is the beginning of the data pipeline. It generates
-EBU-TT-Live documents in a timed manner. In the repository root there is a *test.html* file that can be used for manual testing of the producer in any websocket capable browser.
+The simple producer is the beginning of the data pipeline. It generates EBU-TT-Live documents in a timed manner. In the repository root there is a *test.html* file that can be used for manual testing of the producer in any websocket capable browser. To run it use `ebu-run`:
 
-    ebu-simple-producer
+    `ebu-run --admin.conf ebu_tt_live/examples/config/simple_producer.json`
 
 The simple consumer connects to the producer or later on in the pipeline, assuming there are more components inserted.
 
-    ebu-simple-consumer
+  `ebu-run --admin.conf ebu_tt_live/examples/config/simple_consumer.json`
 
-The user input consumer script is intended to receive data from the user input producer. The user input producer is a user interface that allows users to create documents
-and to send them live (see the documentation for details). To run it, just run `ebu-user-input-consumer` and open the file `ebu_tt_live/ui/user_input_producer/user_input_producer.html` file.
+The User Input producer is a web page with a user interface that allows you to send subtitle documents and view the output of a downstream node. For complete documentation see `docs/build/html/user_input_producer.html`.
 
-    ebu-user-input-consumer
+To run a configuration of components, use a configuration file with multiple nodes defined. For example, this will create 3 nodes: a distributer that listens to the UIP and two consumers that subscribe to the distributer:
 
+  `ebu-run --admin.conf ebu_tt_live/examples/config/user_input_producer_dist_consumers.json`   
 
 Documentation
 =============
@@ -124,8 +123,8 @@ To display the images in the documentation, you need to have [Graphviz](http://w
 
 ## Generating documentation
 
-Documentation can be generated based on the sources in the docs/source directory. After having installed the packages in 
-requirements.txt (which is done automatically by the make command) documentation can be generated by one of the 
+Documentation can be generated based on the sources in the docs/source directory. After having installed the packages in
+requirements.txt (which is done automatically by the make command) documentation can be generated by one of the
 following three ways:
 
  1 Calling setuptools
@@ -149,15 +148,15 @@ sphinx-build -b html docs/source/ docs/build/html
 
 ## Previewing the documentation
 
-After sphinx finished with a successful execution log the generated documentation should be accessible by opening the 
+After sphinx finished with a successful execution log the generated documentation should be accessible by opening the
 docs/build/html/index.html in any web browser.
 
 Tests
 =====
 
-The test framework is described in [CONTRIBUTING.md](CONTRIBUTING.md) 
+The test framework is described in [CONTRIBUTING.md](CONTRIBUTING.md)
 
 How to contribute
 =================
 
-Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) 
+Please refer to [CONTRIBUTING.md](CONTRIBUTING.md)