Adds run instructions to the README

This commit is contained in:
Miguel de la Cruz 2023-07-01 17:33:30 +02:00
parent 94df957b02
commit a331a45cff

View file

@ -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