From 0b0e91928d878efb8dd1e3f7658b7ce7cd7495c2 Mon Sep 17 00:00:00 2001 From: Miguel de la Cruz Date: Fri, 30 Jun 2023 10:42:27 +0200 Subject: [PATCH] Add example config file --- .gitignore | 1 + Makefile | 4 ++++ README.md | 5 +++++ example-config.yml | 2 ++ 4 files changed, 12 insertions(+) create mode 100644 .gitignore create mode 100644 example-config.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..53c37a1 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +dist \ No newline at end of file diff --git a/Makefile b/Makefile index 0064fe7..ae03b1b 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,7 @@ +build: + mkdir -p dist + go build -o dist ./... + test: GOTESTSUM_FORMAT=testname gotestsum --packages="./..." diff --git a/README.md b/README.md index 6a0eaf4..850a0bb 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,11 @@ 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](./example-config.yml) that +can be used as a base to create your own configuration. + ## Roadmap - [ ] Create the bot scaffold diff --git a/example-config.yml b/example-config.yml new file mode 100644 index 0000000..b28410d --- /dev/null +++ b/example-config.yml @@ -0,0 +1,2 @@ +--- +birthday_file: birthdays.csv