diff --git a/README.md b/README.md index f94dea2..4f687a8 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,58 @@ -# USAGE +# What -As all programs from `Baguette` repositories, a `-h` option is available for the program. +`mailer` is an application to send templated emails. +Templates are in the [Crinja format][crinja] (a Jinja derivative). ```Bash +# Get some help. mailer -h ``` -### Sending a mail +# Sending a mail ```Bash -# One-shot email transfer. +# One-shot email transfer. "login" and "token" are template parameters. # mailer send