From 4d6a5bd05a96829188f7033901e7ccc35a412db8 Mon Sep 17 00:00:00 2001
From: Simon Vieille <simon@deblan.fr>
Date: Sat, 31 Oct 2020 22:00:29 +0100
Subject: [PATCH] add documentation

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bfa0243
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+Le père noël secret
+===================
+
+Tirage au sort d'une personne à qui offrir un cadeau.
+
+## Installation
+
+```
+$ git clone https://gitnet.fr/deblan/le-pere-noel-secret.git
+$ cd le-pere-noel-secret
+$ cp etc/config.php.dist etc/config.php
+```
+
+## Configuration
+
+La racine du site est `public/`.
+
+Éditer `etc/config.php` :
+
+* La liste des personnes qui composent le père noël secret.
+L'index définit la "clé secrète" pour générer le lien à partager
+Pour "Name 1", son lien sera "https://exemple.fr/index.php?p=foo" tandis pour "Name 2" le lien sera "https://exemple.fr/index.php?p=bar".
+* La liste des restrictions pour définir ceux qui ne s'offiront jamais de cadeau
+
+Les résultats sont stockés dans `datas/results.json`.