diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 25 insertions, 4 deletions
@@ -4,12 +4,17 @@ Birthday Notify by email if there is a birthday today. This program is intended to be launched everyday. +Usage +----- + Create birthdates.csv which stores birthdates: ``` -23 Oct 1982, Jean, Dupont -30 Jan 1955, Anne, Doe -08 May 1980, Eric, Carter +23 Oct 1982, Katie, Clarke +30 Jan 1955, Henry, Brown +08 May 1980, Alexander, Khan +02 Aug 1976, Violet, Koval +02 Aug 1976, Jude, Martinez … ``` @@ -21,7 +26,7 @@ mail-from = no-reply@service.com day-for-next-week-notification = Friday ``` -The usage is as follow: +Launch the following commands: ``` cabal sandbox init @@ -29,3 +34,19 @@ cabal instal --only-dependencies cabal build ./dist/build/birthday/birthday ``` + +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 subject + +“Hey, there are 3 birthdays today and there will be 2 birthdays next week!” + +### Mail 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 and Jude +Martinez will be 12 years old.” |