From f8d0bbd001aac6b465b663599ab6235964ab1ace Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fran=C3=A7ois=20Poulain?= <fpoulain@metrodore.fr>
Date: Tue, 25 Aug 2020 09:02:02 +0200
Subject: [PATCH] =?UTF-8?q?pr=C3=A9cise=20des=20d=C3=A9tails=20dans=20le?=
 =?UTF-8?q?=20readme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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

diff --git a/README.md b/README.md
index 38c44d7..d92040d 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,7 @@ Simple mailing script.
 **Table of content**
 
 - [Installation](#installation)
+- [Input format](#input-format)
 - [Licence](#licence)
 
 ## Installation
@@ -29,6 +30,30 @@ following packages:
         $ ./mailing.py --help
         $ ./mailing.py -t test-recipients-data -b test-emailling --dry-run --verbose
 
+## Input format
+
+### CSV
+
+The « to-file » is expected to be csv with the [default
+dialect](https://docs.python.org/3/library/csv.html?highlight=csv#dialects-and-formatting-parameters)
+(delimiter = `,` and char delimiter =`"`).
+
+The first line declare columns headers. The `from` and `to` headers are
+expected the be found. Headers are lower cased.
+
+To avoid boring repetition it is possible to declare a default column value
+using `:` in header. The default value is considered when the column is lacking,
+not when the column is empty.
+
+### Templates
+
+The templates files are expected to be [jinja2
+templates](https://jinja.palletsprojects.com/en/2.11.x/templates/). The csv
+values are accessible using the column name, i.e. one can insert the recipient
+address anywhere in template using `{{ to }}`.
+
+Don't worry about escaping: HTML templates are auto escaped.
+
 ## License
 
 Spamotron is developed by April and licensed under the [GPLv2+](LICENSE).