diff --git a/README.md b/README.md index 26bdf6b..6d2101a 100644 --- a/README.md +++ b/README.md @@ -136,10 +136,12 @@ docker run -d --name rsvp-manager \ npm start ``` -## Email Notifications (Currently in dev branch!) +## Email Notifications By setting up the environment variables in the `docker-compose.yml`, you can have notifications sent to the recipients of your choice when someone submits an RSVP to an event. The notification will include the details of their submission and links to view or manage the RSVPs for that event. +Users will also have the option to get an email confirmation of their submission that will include a unique link to view/edit their submission! + ## Authentication with Authentik This application is compatible with Authentik. Make sure to create a Proxy Provider for Forward auth (single application). To protect the admin & create routes, add the following configuration to your Nginx Proxy Manager config in the Advanced section. For other web server applications, see the Setup area in Authentik on the Provider page for this app and setup the routes accordingly.