aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoris2015-10-09 23:12:45 +0200
committerJoris2015-10-09 23:12:45 +0200
commit40b8c60d61eaa1d28c7010093a138ef7437b002b (patch)
tree07a81a7e89bbe95e883e9d99284fe4c2ce8d3195 /README.md
parent1ab8ca19cdf45a0e364a253b16ee3989a52c3051 (diff)
downloadevents-40b8c60d61eaa1d28c7010093a138ef7437b002b.tar.gz
events-40b8c60d61eaa1d28c7010093a138ef7437b002b.tar.bz2
events-40b8c60d61eaa1d28c7010093a138ef7437b002b.zip
Add config information to the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/README.md b/README.md
index fd0d2d0..9e1d0b3 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,22 @@
Birthday
========
-Send an email to notify if there is a birthday today. Birthdates are parsed
-from a csv file:
+Notify by email if there is a birthday today. Birthdates are parsed from a csv
+file:
```
-23/10/1982 , Dupont Jean
-30/01/1955 , Doe Anne
+23/10/1982 , Dupont , Jean
+30/01/1955 , Doe , Anne
```
+Mail contacts are given in the config file:
+
+```
+mail-to = john.dupont@mail.com
+mail-from = no-reply@service.com
+```
+
The usage is as follow:
```