From 13aa6a2019a8378b33ea345bfaea034f1539f6b9 Mon Sep 17 00:00:00 2001
From: Karchnu <karchnu@karchnu.fr>
Date: Sun, 1 Nov 2020 21:56:41 +0100
Subject: [PATCH] README, default template repository, template example.

---
 README.md                    | 50 ++++++++++++++++++++++++++++++++++++
 src/mailer.cr                |  2 +-
 templates/activation-mail.j2 | 16 ++++++++++++
 3 files changed, 67 insertions(+), 1 deletion(-)
 create mode 100644 README.md
 create mode 100644 templates/activation-mail.j2

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9e160bb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# USAGE
+
+As all programs from `Baguette` repositories, a `-h` option is available for the program.
+
+```Bash
+mailer -h
+```
+
+### Sending a mail
+
+```Bash
+# One-shot email transfer.
+# mailer send <template> <email>
+login=mypseudo token=aabbccdd  mailer send activation-email test@example.com
+```
+
+### Configuration
+
+As all programs from `Baguette` repositories, a configuration file either in the `$XDG_CONFIG_HOME/baguette/` (first guess) or in the `/etc/baguette/` directory can be used.
+
+Here an exhaustive example:
+
+```YAML
+# ~/.config/baguette/mailer.yml
+
+# SMTPd configuration.
+smtpd_host: localhost
+smtpd_port: 25
+
+# Where to find templates, if not in the defaut directory (/etc/baguette/mailer/templates/).
+template_directory: /path/to/mailer/templates
+
+# Configuration for each template.
+templates:
+    # Template name, associated to the mail configuration: "from" and "subject" headers.
+    mail-activation-fr:
+        from: no-reply@example.com
+        subject: Account activation on the example.com website
+    mail-recovery-fr:
+        from: no-reply@example.com
+        subject: Mail recovery for the example.com website
+```
+
+### Templates
+
+Templates:
+- are in the [Crinja format][crinja] (a Jinja derivative)
+- located by default in `/etc/baguette/mailer/templates`
+
+[crinja]: https://github.com/straight-shoota/crinja
diff --git a/src/mailer.cr b/src/mailer.cr
index 7407c8d..0235c57 100644
--- a/src/mailer.cr
+++ b/src/mailer.cr
@@ -23,7 +23,7 @@ class Baguette::Configuration
 
 		# template => subject
 		property templates            : YAML::Any? = nil
-		property templates_directory  : String = "templates/"
+		property templates_directory  : String = "/etc/baguette/mailer/templates/"
 
 		def initialize
 		end
diff --git a/templates/activation-mail.j2 b/templates/activation-mail.j2
new file mode 100644
index 0000000..10081f7
--- /dev/null
+++ b/templates/activation-mail.j2
@@ -0,0 +1,16 @@
+Hello {{ login }}!
+
+You subscribed to the example.com website!
+
+Please, use the following link to activate your account:
+
+	https://example.com/account-activation/{{ login }}/{{ token }}
+
+
+In the case you are not {{ login }} from the example.com, you can dismiss this email.
+
+
+Thanks!
+
+-- 
+example.com