Merge branch 'feature/rebase'

1 files changed, 16 insertions, 1 deletions

diff --git a/README.md b/README.md
index 1c0375b..7c7a3a6 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ We try to build a generic abstraction stack between our different resources (CPU
   * ansible (physical node conf)
   * nomad (schedule containers)
   * consul (distributed key value store / lock / service discovery)
-  * glusterfs (file storage)
+  * garage/glusterfs (file storage)
   * stolon + postgresql (distributed relational database)
   * docker (container tool)
   * bottin (LDAP server, auth)
@@ -23,6 +23,21 @@ Some services we provide:
 
 As a generic abstraction is provided, deploying new services should be easy.
 
+## I am lost, how this repo works?
+
+To ease the development, we make the choice of a fully integrated environment
+
+  1. `os` the base os for the cluster
+      1. `build`: where you will build our OS image based on Debian that you will install on your server
+      2. `config`: our Ansible recipes to configure and update your freshly installed server
+  2. `apps` apps we deploy on the cluster
+      1. `build`: our Docker files to build immutable images of our applications
+      2. `integration`: Our Docker compose files to test locally how our built images interact together
+      3. `config`: Files containing application configurations to be deployed on Consul Key Value Store
+      4. `deployment`: Files containing application definitions to be deployed on Nomad Scheduler
+  3. `op_guide`: Guides to explain you operations you can do cluster wide (like configuring postgres)
+
+
 ## Start hacking
 
 ### Clone the repository