birthdaybot/README.md

Birthday bot

A simple bot that notifies of birthdays, posting the contact information of the subject so you can reach them easily.

Configuration

There is an example configuration file that can be used as a base to create your own configuration, and there is a birthdays example CSV file to load the data.

Run the bot

To get help for the bot command, run:

$ ./birthdaybot -help
Usage of ./birthdaybot:
  -config string
        path to the configuration file (default "birthdaybot.yml")

To run the server with the development defaults, run:

$ make run

Roadmap

• Create the bot scaffold
• Define how to read the birthdays info
• Add a logger instance to the config
• Add config validation on server creation
• Create a configurable template to fill with each notification
• Create different message systems to use with the bot
• Reduce logger verbosity
• Enjoy!