diff --git a/README.md b/README.md index cdc94a2..8634689 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,23 @@ There is an [example configuration file](./example-config.yml) that can be used as a base to create your own configuration, and there is a [birthdays example CSV file](./birthdays.csv) to load the data. +## Run the bot + +To get help for the bot command, run: + +```sh +$ ./birthdaybot -help +Usage of ./birthdaybot: + -config string + path to the configuration file (default "birthdaybot.yml") +``` + +To run the server with the development defaults, run: + +```sh +$ make run +``` + ## Roadmap - [X] Create the bot scaffold