Adds run instructions to the README
This commit is contained in:
parent
94df957b02
commit
a331a45cff
1 changed files with 17 additions and 0 deletions
17
README.md
17
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
|
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.
|
[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
|
## Roadmap
|
||||||
|
|
||||||
- [X] Create the bot scaffold
|
- [X] Create the bot scaffold
|
||||||
|
|
Loading…
Reference in a new issue