diff --git a/README.md b/README.md index 5f8208bdcdffc3e9496db62f7c02f1947c679a54..8cb9468e2be0d90e1610d9d3b82145117daefd0d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ -# preacher-telegram-bot +# PreacherBot Preacherbot is a community developed Telegram bot that facilitates the weekly Church of Monero Mass. + +## Installation +`docker-compose build` + +## Running +First, you will need to export the following environment variables: + +`PREACHER_TELEGRAM_TOKEN` - your Telegram bot's access token + +`MONGO_INITDB_ROOT_USERNAME` (optional, defaults to "root") + +`MONGO_INITDB_ROOT_PASSWORD` (optional, defaults to "default_password") + + +Then start the container in the background: + +`docker-compose up -d`