diff --git a/README.md b/README.md index c15167c..0e5f682 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ -# Keycloak Notifier \ No newline at end of file +# Keycloak Notifier + +## Example `.env`: + +```yaml +KEYCLOAK_ADMIN_ID= +KEYCLOAK_PASSWORD= +KEYCLOAK_REALM=master +KEYCLOAK_URL=https://auth.mydomain.com/ +KEYCLOAK_USERNAME=admin +SMTP_HOST=smtp.mydomain.com +SMTP_PASSWORD= +SMTP_PORT=465 +SMTP_RECEIVER=my@email.com +SMTP_SENDER=smtp.mydomain.com +```