diff --git a/README.md b/README.md index 7f87156..2af96ba 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,22 @@ The bot calls the Api and sends the invitation link via e-mail to a given receip ## Usage -Use container image or run this after cloning: +Use container image or run this after cloning. In both cases you need to create a `.env` file containing the matrix and mail server credentials: + +``` +cp. .env.example .env +``` + +If you want to run it without the container you can run it like this: + ``` . bin/activate python -m matrix_bot_invitation_mailer ``` +And for use with docker run it like this: + +``` +docker compose up -d +```