From 0cb0c0a7d37c9a778c43d4ac1f695762fa6641d3 Mon Sep 17 00:00:00 2001
From: Julien Oculi <xdrz.jot.sr@gmail.com>
Date: Wed, 29 May 2024 14:19:50 +0200
Subject: [PATCH] doc: update main README

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 50 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 441c678..e195e6a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,51 @@
-# server_config
+# Server Config
 
-Fichiers de configuration du serveur Coh@bit.
\ No newline at end of file
+Fichiers de configuration du serveur Coh@bit.
+
+## Usage fénéral
+
+Cloner ce dépôts sur votre système (pas de répertoire privilégié).
+
+## Installation
+
+Pour installer les différents services/apps dur serveur.
+
+### Usage
+
+```sh
+sudo (bash|sh|zsh) ./install.sh [SERVICES...]
+```
+
+### Examples
+
+- Install `caddy` and `iptables`
+  ```sh
+  sudo ./install.sh caddy iptables
+  ```
+- Install all services
+  ```sh
+  sudo ./install.sh *
+  ```
+
+## Déploiement
+
+Pour déployer les différents services/apps dur serveur.
+
+Nécessite d'avoir [installer les services](#installation) au préalable.
+
+### Usage
+
+```sh
+sudo (bash|sh|zsh) ./deploy.sh [SERVICES...]
+```
+
+### Examples
+
+- Install `caddy` and `iptables`
+  ```sh
+  sudo ./deploy.sh caddy iptables
+  ```
+- Install all services
+  ```sh
+  sudo ./deploy.sh *
+  ```