From 2146bf8629b211edbc102499f0f624f7b959c2ad Mon Sep 17 00:00:00 2001 From: ryansurf Date: Wed, 22 May 2024 16:43:29 -0700 Subject: [PATCH] TESTING --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 15cb4cd..d5b3739 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,18 @@ Change `.env.example` to `.env` | Variable | Description| | -------- | ------- | | `PORT=` | The port you want to open to run the application. Default = 8000 | +| `SMTP_SERVER=` | The email server you are using. Default = smtp.gmail.com | +| `EMAIL=` | The email you will send the report from. | +| `EMAIL_PW=` | The sending email's password | +| `EMAIL_RECEIVER=` | The email that will receive the report (your personal email) | +| `COMMAND=` | The command that will be ran and shown in the email. Default = `localhost:8000` | +| `SUBJECT=` | The email's subject. Default = Surf Report | + +**Email Server** + +Optional, sends a surf report to a specified email. + +You will need to setup an email account that is able to utilize SMTP services. I used Gmail, following Method #1 outlined [here](https://www.cubebackup.com/blog/how-to-use-google-smtp-service-to-send-emails-for-free/). After doing this, change the variables in `.env` ## Development