From 802418ee7eb52121c0d1aa5491609e455fdd98f8 Mon Sep 17 00:00:00 2001
From: DG <davegallant@gmail.com>
Date: Sat, 21 Aug 2021 17:46:37 -0400
Subject: [PATCH] Add required environment variables (#105)

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 1df7f86..5d66044 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,16 @@ OPTIONS:
     -d, --dbpath <dbpath>    Specify path to where the embedded database is stored [default: ./deals_db]
 ```
 
+## Environment Variables
+
+The following environment variables are required:
+
+| VARIABLE            | DESCRIPTION                                                      |
+| ------------------- | ---------------------------------------------------------------- |
+| SENDGRID_API_KEY    | Key can be created at https://app.sendgrid.com/settings/api_keys |
+| SENDGRID_MAIL_FROM  | The email address that the email is sent from                    |
+| SENDGRID_MAIL_TO    | The email address to notify                                      |
+
 ## Github action
 
 An action can be setup to scan for deals, send a notification and store previously found deals in the repo.