From 4bfe701a002ee8507a0cee795157b0bb844c9060 Mon Sep 17 00:00:00 2001
From: mco-system <michael.costa@mcos.nc>
Date: Mon, 28 Feb 2022 08:16:52 +1100
Subject: [PATCH] doc: README.md

Signed-off-by: mco-system <michael.costa@mcos.nc>
---
 .editorconfig | 11 +++++++++++
 README.md     | 37 ++++++++++++++++++++++++++++++++++++-
 blacklist.txt |  0
 whitelist.txt |  0
 4 files changed, 47 insertions(+), 1 deletion(-)
 create mode 100644 .editorconfig
 create mode 100644 blacklist.txt
 create mode 100644 whitelist.txt

diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..17d1b53
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,11 @@
+root = true
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 80
+ruler = 80
+[Makefile]
+indent_style = tab
diff --git a/README.md b/README.md
index c851667..f476010 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,38 @@
 # spamlists
 
-Blacklists et whitelists automagiquement appliquées sur le mailer du Tetalab.
\ No newline at end of file
+Blacklists et whitelists automagiquement appliquées sur le serveur de courriels du  du **Tetal@b** aka `billy`.
+
+## Comment ça marche©
+
+### Liste noire
+
+Les adresses de courriel listées dans le fichier `balcklist.txt` sont automatiquement enregistrées comme des adresses de courriel interdites sur le serveur de courriels du **Tetal@b**.
+
+Le bannissement est effectuée à deux endroits:
+- Le serveur de courriels (_Postfix_)
+- _SpamAssassin_
+
+**Attention**: Les modifications poussées sur ce dépôt provoque le redémarrage du serveur de courriels du **Tetal@b** ainsi que de l'instance _SpamAssassin_.
+
+### Liste blanche
+
+Les adresses de courriel listées dans le fichier `whitelist.txt` sont automatiquement enregistrées comme des adresses de courriel autorisées sur le serveur de courriels du **Tetal@b**.
+
+Le bannissement est effectuée à deux endroits:
+- Le serveur de courriels (_Postfix_)
+- _SpamAssassin_
+
+**Les adresses de courriels en liste blanche outrepassent la vérification anti-spam**
+
+### Format des listes
+
+Chacune des deux listes (`blacklist.txt` et `whitelist.txt`) doit comporter une seule adresse de courriel par ligne.
+
+Les motifs de type _glob_ sont acceptés, ainsi pour bannir le domaine `example.com` il suffit d'ajouter l a ligne suivante au fichier `blacklist.txt`
+
+```
+*.example.com
+```
+
+**Les motifs ne sont PAS des expressions régulières mais des _globs_ comme ceux utilisés pour la manipulation des systèmes de fichiers**
+
diff --git a/blacklist.txt b/blacklist.txt
new file mode 100644
index 0000000..e69de29
diff --git a/whitelist.txt b/whitelist.txt
new file mode 100644
index 0000000..e69de29