ligned up readme

README.md

@@ -1,29 +1,64 @@
 # README #
 
-This README would normally document whatever steps are necessary to get your application up and running.
-
 ### What is this repository for? ###
 
-* Quick summary
+* Overview
+
+This repository contains instructions to setup the D4S VRE Manager island
+  
 * Version
-* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
+
+0.0.1
+
+* Dependencies
+
+This repository depends on D4S CDN (https://code-repo.d4science.org/gCubeSystem/d4s-cdn-setup.git).
 
 ### How do I get set up? ###
 
 * Summary of set up
-* Configuration
-* Dependencies
-* Database configuration
-* How to run tests
+
+This repository contains all information to build a D4S VRE Manager image. Most importantly it contains the ansible instructions to deploy a swarm, CDN VRE manager island and PEP.
+
 * Deployment instructions
 
-### Contribution guidelines ###
+There are 4 branches.
+
+__main__ branch contains configurations to start a local instance useful for development. It is configured to use the D4SCience dev IAM.
+
+__dev__ branch contains the configuration to run on D4Science Docker swarm cluster acting on the DEV infrastructure. 
 
-* Writing tests
-* Code review
-* Other guidelines
+__pre__ branch contains the configuration to run on D4Science Docker swarm cluster acting on the PRE infrastructure. 
+
+__prod__ branch contains the configuration to run on D4Science Docker swarm cluster acting on the PROD infrastructure.
+
+In order to run a local site the following commands need to be executed:
+
+```
+git clone https://code-repo.d4science.org/gCubeSystem/d4s-vre-manager-setup.git
+ansible-playbook site.yaml --ask-vault-pass
+```
+This will create a basic stack with an NGINX based PEP and base navigation service.
+
+If you want to deploy on a specific D4S infrastructure please clone the corresponding branch.
+
+```
+git clone -b {infra} https://code-repo.d4science.org/gCubeSystem/d4s-vre-manager-setup.git
+ansible-playbook site.yaml --ask-vault-pass
+```
+
+* Commit guidelines 
+
+DO NOT commit the following files:
+
+conf/pep/config.js
+conf/service/auth.js
+
+They will be generated by the ansible based deployment procedure in order to inject the secrets.
 
 ### Who do I talk to? ###
 
 * Repo owner or admin
-* Other community or team contact
+
+Marco Lettere
+marco.lettere@nubisware.com