adding email config template

omar2535 · Sep 8, 2020 · 47e8993 · 47e8993
1 parent 5a650ae
commit 47e8993
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/config/email_config.template.yml b/config/email_config.template.yml
@@ -0,0 +1,4 @@
+user: [email protected]
+pass: "abcdefg"
+receiver: "[email protected]"
+subject: "Email notification"
diff --git a/readme.md b/readme.md
@@ -48,6 +48,10 @@ The start date to be searched through in `YYYY-MM-DD` format
 
 true / false value as a string indicating whether to send an email or not
 
+## Setting up email_config.yml
+
+Move the email_config.template.yml to email_config.yml and fill in the required fields
+
 ## Usage
 
 This program can be run in the background by simply running it with: