From e5ce3c85917639daa00f9b25e002cfb62878b82e Mon Sep 17 00:00:00 2001
From: Elodie Chapeaublanc <elodie.chapeaublanc@pasteur.fr>
Date: Fri, 21 Jun 2024 15:05:57 +0200
Subject: [PATCH] add more details in README file

---
 README.md | 26 ++++++++++++++++----------
 1 file changed, 16 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index ac9b170..5431c1b 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,22 @@
-# shiny-k8s-example
+# Branch "base-common" - Project shiny-k8s-example
 
-This project is a satellite project containing example(s) on how to use components developped in [hub/shiny-k8s](https://gitlab.pasteur.fr/hub/shiny-k8s).
+The branch [base-common](https://gitlab.pasteur.fr/hub/shiny-k8s-example/-/tree/base-common?ref_type=heads) contains material common to [base-r](https://gitlab.pasteur.fr/hub/shiny-k8s-example/-/tree/base-r?ref_type=heads) and [base-python](https://gitlab.pasteur.fr/hub/shiny-k8s-example/-/tree/base-python?ref_type=heads) branches.
 
-* The base example with R language is the branch [base-r](https://gitlab.pasteur.fr/hub/shiny-k8s-example/-/tree/base-r?ref_type=heads)
-* The base example with Python is the branch [base-python](https://gitlab.pasteur.fr/hub/shiny-k8s-example/-/tree/base-python?ref_type=heads)
+Don't use this branch directly.\
+Please go to [base-r](https://gitlab.pasteur.fr/hub/shiny-k8s-example/-/tree/base-r?ref_type=heads) or [base-python](https://gitlab.pasteur.fr/hub/shiny-k8s-example/-/tree/base-python?ref_type=heads) branches according to your language used in your Shiny App.
 
-For more information, see [Documentation](https://hub.pages.pasteur.fr/shiny-k8s/).
+# Project structure
 
-# Developpers
+This project use orphan branch concept [^1] to manage the different ressources using according to the usage.
 
-The branch [base-common](https://gitlab.pasteur.fr/hub/shiny-k8s-example/-/tree/base-common?ref_type=heads) contains material common to base-r and base-python.
+```ini
+shiny-k8s
+  ├── main
+  ├── base-common
+  │   ├── base-r
+  │   └── base-python
+  ├── advanced-scripts
+  └── doc-trigger
+```
 
-# Scripts
-
-Scripts for different category of users can be found in branch [advanced-scripts](https://gitlab.pasteur.fr/hub/shiny-k8s-example/-/tree/advanced-scripts).
\ No newline at end of file
+[^1]: [git definition](https://git-scm.com/docs/git-checkout/2.14.6#Documentation/git-checkout.txt---orphanltnewbranchgt)
-- 
GitLab