From c642370def01f09d966b3b9c643cfe416ea115cf Mon Sep 17 00:00:00 2001
From: Quentin <quentin@deuxfleurs.fr>
Date: Mon, 18 Jan 2021 08:08:48 +0100
Subject: [PATCH] Add hierarchy to the README

---
 app/README.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/app/README.md b/app/README.md
index 21eb936..3049cac 100644
--- a/app/README.md
+++ b/app/README.md
@@ -1,4 +1,14 @@
-## How to install `secretmgr`
+## Understand this folder hierarchy
+
+This folder contains the following hierarchy:
+
+- `<module>/build/<image_name>/`: folders with dockerfiles and other necessary resources for building container images
+- `<module>/config/`: folder containing configuration files, referenced by deployment file
+- `<module>/secrets/`: folder containing secrets, which can be synchronized with Consul using `secretmgr.py`
+- `<module>/deploy/`: folder containing the HCL file(s) necessary for deploying the module
+- `<module>/integration/`: folder containing files for integration testing using docker-compose
+
+## How to install `secretmgr.py` dependencies
 
 How to install its dependencies:
 
@@ -12,7 +22,7 @@ apt-get install -y libldap2-dev
 pip3 install --user --requirement requirements.txt
 ```
 
-## How to use `secretmgr`
+## How to use `secretmgr.py`
 
 Check that all secrets are correctly deployed for app `dummy`: