From a331a45cffe19a13d548e5cbe55ca9b3d43d87d6 Mon Sep 17 00:00:00 2001
From: Miguel de la Cruz <miguel@mcrx.me>
Date: Sat, 1 Jul 2023 17:33:30 +0200
Subject: [PATCH] Adds run instructions to the README

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

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