From 57a98914e79b5b780b9f11e5ce4713e3b5f9982c Mon Sep 17 00:00:00 2001
From: Kazhnuz <kazhnuz@kobold.cafe>
Date: Fri, 24 May 2024 17:44:11 +0200
Subject: [PATCH] doc: un peu de dock pour la documentation

---
 README.md | 29 ++++++++++++++++++++++++-----
 1 file changed, 24 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 65de2c6..57347e7 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,31 @@ Embarcadère est une petite page simple que j'ai créé pour me servir de page d
 
 ## Modifier la page
 
-- La page HTML contient toute les données, les liens et les éléments utilisable.
-- Pour changer le moteur de recherche, il suffit de remplacer l'action et le "name" du champ de recherche
-- Les icones utilisable sont [trouvable ici](https://forkaweso.me/Fork-Awesome/icons/)
-- Les couleurs sont modifiable via les variable css utilisées.
+Le site peut être modifié via le fichier `_data/config.json`, de la manière suivante.
+
+## Ajouter des sites
+
+Les sites sont inclu dans les variables `featuredSites` ou dans des blocks dans la variable `siteBlocks`. Pour modifier les sites "mis en avant" (les boutons colorés), il vous suffit de modifier les sites qui sont géré de la manire suivante.
+
+```json
+  "featuredSites":[
+    {"nom":"<nom qui sera affiché sur le bouton>", "url":"<url du site>", "emoji":"<Un emoji à utiliser>"},
+  ]
+```
+
+Pour modifier les sites dans les blocks, vous pouvez le faire de la manière suivante
+
+```json
+  "siteBlocks":[
+    {
+      "nom":"<nom du block>",
+      "sites":[
+        {"nom":"<nom qui sera affiché sur le lien>", "url":"<url du site>", "emoji":"<Un emoji à utiliser>"},
+      ]
+    },
+  ]
+```
 
 ## Crédits
 
-- Icones par fork-awesome
 - Fond d'écran venant d'Elementary OS, fait par Ashim DSilva