From: Edward Delaporte <edward@delaporte.us>
Date: Sat, 28 Mar 2026 01:02:17 +0000 (-0500)
Subject: Add README
X-Git-Url: https://us-delaporte.pagekite.me/gitweb/matrix-chore-bot.git/commitdiff_plain/97cc588b82a7aaee42578e12f05e8eb46f6a520a

Add README
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..87496d7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+## About
+
+A matrix bot that tracks daily chore completion.
+
+
+Add a list of chores, and tell the bot when they are done.
+Ask the bot for status of the list.
+
+Chores that have not been marked completed for one day are treated as undone.
+
+Works well with, and is included in [Cadbury, the all many purpose Matrix bot](https://codeberg.org/EdTheDev/matrix-cadbury).
+
+## Usage
+
+Configure the necessary environment variables, and run with `make serve`.
+
+Invite the bot to a Matrix channel, and it will accept automatically, if it can.
+
+Use `!chore help`, to get started.
+
+> Tip: Additional setup is required to add a Matrix bot to an encrypted channel.
+
+```
+!chore help
+
+Prefix: !chore
+
+    Synax:
+        !chore COMMAND ARGS
+
+    Commands:
+      help - show this help
+      add - add a daily chore
+      check - check status of a chore
+      done - mark a chore as done
+      list - print the daily chore list (including status)
+      undo - mark a chore as undone
+      remove - remove a daily chore
+```
+