From d8eedc3e2639f0f50f0554f89dc121da4941d4d1 Mon Sep 17 00:00:00 2001
From: Joris
Date: Mon, 4 Apr 2016 22:48:33 +0200
Subject: Rename birthday to event

---
 README.md | 56 +++++++++++++++++++++++++++-----------------------------
 1 file changed, 27 insertions(+), 29 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 41f4a36..e196120 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,11 @@
-Birthday
-========
+Event
+=====
 
-Notify by email if there are any birthday today or next week. This program is
-intended to be launched everyday.
+Notify by email if there are any event today or next week. This program has to
+be launched everyday, with cron for example.
 
-## Required dependencies
+Required dependencies
+---------------------
 
 - `cabal2nix`
 - `nix-shell`
@@ -13,26 +14,26 @@ intended to be launched everyday.
 Usage
 -----
 
-Create birthdates.csv which stores birthdates:
+Create the events file:
 
 ```
-# Family
-30 Jan 1955,     Henry, Brown
-08 May 1980, Alexander, Khan
-
-# Friends
-02 Aug 1976,    Violet, Koval
-02 Aug 1976,      Jude, Martinez
-23 Oct 1982,     Katie, Clarke
-…
-```
+[January]
 
-Create config.txt:
+30, 1955: Henry Brown
 
-```
-mail-to = john.dupont@mail.com
-mail-from = no-reply@service.com
-day-for-next-week-notification = Friday
+[May]
+
+08, 1980: Alexander Khan
+16, 2003: Wedding
+
+[August]
+
+02, 1976: Violet Koval
+02, 1976: Jude Martinez
+
+[October]
+
+23, 1982: Katie Clarke
 ```
 
 Launch the following commands:
@@ -43,17 +44,14 @@ nix-shell -I ~ --command 'cabal configure'
 cabal run
 ```
 
-Notification
-------------
-
-Notification are in plan english so that it is more friendly to read them. Here
-is an example notification with 3 birthdays today and 2 birthdays next week:
+Mail Notification example
+-------------------------
 
-### Mail subject
+### Subject
 
-“Hey, there are 3 birthdays today and there will be 2 birthdays next week!”
+“Hey, there are 3 events today and there will be 2 events next week!”
 
-### Mail body
+### Body
 
 “Today, Katie Clarke is 19 years old, Henry Brown is 34 years old and Alexander
 Khan is 22 years old. Next week, Violet Koval will be 65 years old on thirsday
-- 
cgit v1.2.3