Merge pull request #152 from anapolg/master

Readme update

README.md

@@ -8,26 +8,14 @@
 
 This repository contains the `tng-sdk-validation` component that is part of the European H2020 project [5GTANGO](http://www.5gtango.eu) NFV SDK. This component can be used to validate the syntax, integrity and topology of 5GTANGO file descriptors. Besides, `tng-sdk-validation` can be used through the CLI, as service  or as a micro-service running inside a docker container.
 
-# Dependencies
+## Installation
 
-This tool has been designed to be executed in Linux system and Python 3.6 or higher. In addition, it is necessary to have installed the [tng-sdk-project](https://github.com/sonata-nfv/tng-sdk-project) before starting.
-
-Other requirements are specified [here](https://github.com/sonata-nfv/tng-sdk-validation/blob/master/requirements.txt). They can be installed with the following statement:
-
-```
-pip3 install -r requirements.txt
-```
-
-# Installation
-## Automated
-
-It is possible to use the following command for automatic installation
+Run the following command for automatic installation:
 
 ```
 pip3 install git+https://github.com/sonata-nfv/tng-sdk-validation.git
 ```
 
-## Manual
 Manual installation is possible with:
 
 ```
@@ -36,7 +24,17 @@ cd tng-sdk-validation
 sudo python3 setup.py install
 ```
 
-## Hint
+### Dependencies
+
+This tool has been designed to be executed in Linux system and Python 3.6 or higher. In addition, it is necessary to have installed the [tng-sdk-project](https://github.com/sonata-nfv/tng-sdk-project) before starting.
+
+Other requirements are specified [here](https://github.com/sonata-nfv/tng-sdk-validation/blob/master/requirements.txt). They can be installed with the following statement:
+
+```
+pip3 install -r requirements.txt
+```
+
+### Hint
 It is a good practice to first create a new virtual environment in which all 5GTANGO SDK tools can be installed. You can do this as follows:
 
 ```
@@ -50,11 +48,11 @@ virtualenv -p <path/to/python3> venv
 source venv/bin/activate
 ```
 
-# Usage
+## Usage
 
 The validator can either be used as a command line tool (CLI mode) or as a micro service which offers a REST API.
 
-## CLI mode
+### CLI mode
 
 Runs the validator locally from the command line. Details about all possible parameters can be shown using:
 
@@ -64,15 +62,15 @@ tng-sdk-validate -h
 
 More details on the usage and some examples of the validator can be found on the [wiki](https://github.com/sonata-nfv/tng-sdk-validation/wiki).
 
-## Service mode
+### Service mode
 
 Runs the validator as a service that exposes a REST API:
 
 ```
 tng-sdk-validate --api
 ```
 
-### Running dependencies
+#### Running dependencies
 Validator running as a service needs a **redis BSD** listening in port **6379** to perform the validation. Therefore:
 
 ```
@@ -83,7 +81,7 @@ apt-get install redis-server
 redis-server --port 6379
 ```
 
-## Docker-based service
+### Docker-based service
 
 ```
 #create the docker image
@@ -93,32 +91,32 @@ docker build --no-cache -f ./Dockerfile -t registry.sonata-nfv.eu:5000/tng-sdk-v
 docker run --rm -d --name tng-sdk-validate registry.sonata-nfv.eu:5000/tng-sdk-validation
 ```
 
-# Development
+## Development
 
 To contribute to the development of this 5GTANGO component, you may use the very same development workflow as for any other 5GTANGO Github project. That is, you have to fork the repository and create pull requests.
 
-## Setup development environment
+### Setup development environment
 
 ```
 python3 setup.py
 ```
 
-# Tests
+## Tests
 Validator tests can be run manually on your local machine. To do so, you need to do:
 
 ```
 pytest -v
 ```
 
-# Documentation
+## Documentation
 
 Please refer to the [wiki](https://github.com/sonata-nfv/tng-sdk-validation/wiki) of the project for a more detailed documentation.
 
-# License
+## License
 
 This 5GTANGO component is published under Apache 2.0 license. Please see the LICENSE file for more details.
 
-## Lead Developers
+### Lead Developers
 
 The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
 
@@ -127,7 +125,7 @@ The following lead developers are responsible for this repository and have admin
 * Daniel Fernández Calvo <[email protected]>
 * Miguel Rivas Costa <[email protected]>
 
-## Feedback-Chanel
+### Feedback-Chanel
 
 - You may use the mailing list [sonata-dev-list](mailto:[email protected])
 - Gitter room [![Gitter](https://badges.gitter.im/sonata-nfv/Lobby.svg)](https://gitter.im/sonata-nfv/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)