From 2ac3b784aebfa72b1e6647bd385c6942886c95c2 Mon Sep 17 00:00:00 2001
From: QDIBYS <alexis.szmundy@insee.fr>
Date: Fri, 12 Jul 2024 14:55:47 +0200
Subject: [PATCH] Update README.md

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index 4d2622b7..50b437fb 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,18 @@ User documentation and functional tests are still in an [inhouse project](https:
 
 Kraftwerk uses [Lombok](https://projectlombok.org/).
 
+## Launch
+
+If no argument is specified in the `java -jar` command, Kraftwerk will launch
+as a REST API.
+Otherwise, it will launch on batch mode and apply treatments on one campaign
+with the specified arguments.
+The required arguments for batch mode are as follows (in order) :
+1. Service to use (`MAIN`,`FILEBYFILE`,`GENESIS`,`LUNATIC_ONLY`)
+2. Archive at end of execution (`false` or `true`)
+3. Integrate all reporting datas (`false` or `true`)
+4. Campaign name
+
 :fr:
 
 Kraftwerk est une application Java Spring conçue pour valider et traiter des données provenant d'enquêtes multimodes, afin de générer des tableaux de données prêts à être utilisés à des fins statistiques.
@@ -37,3 +49,14 @@ La documentation utilisateur et les tests fonctionnels sont encore dans un [proj
 * Maven 3.6 +
   
 Kraftwerk utilise [Lombok](https://projectlombok.org/).
+
+## Lancement
+
+Si aucun paramètre n'est spécifié dans la commande `java -jar`, Kraftwerk se lancera
+en tant qu'API REST.
+Sinon, il va se lancer en mode batch et appliquer les traitements sur une campagne
+avec les paramètres spécifiés. Les paramètres requis pour le mode batch sont les suivants (dans l'ordre) :
+1. Service à utiliser (`MAIN`,`FILEBYFILE`,`GENESIS`,`LUNATIC_ONLY`)
+2. Archiver à la fin de l'exécution (`false` ou `true`)
+3. Integrate all reporting datas (`false` ou `true`)
+4. Nom de la campagne
\ No newline at end of file