From: Edward Delaporte Date: Tue, 14 Apr 2026 03:35:02 +0000 (-0500) Subject: Fixup README X-Git-Url: https://apps.delaporte.us/gitweb/matrix-fridge-bot.git/commitdiff_plain/fa7ee8bc2997381cf755f4977949b575fdd06ad6?ds=inline Fixup README --- diff --git a/README.md b/README.md index 51347e2..ce9a5b7 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ ## About -A matrix bot that tracks daily chore completion. +A matrix bot that tracks fridge contents. +Tell it what you add to the fridge with `!fridge add`, +and it will track what was added and when, +and will periodically remind members of the chat room +to eat left-overs and/or toss food that is too old. -Add a list of chores, and tell the bot when they are done. -Ask the bot for status of the list. +Works well with, and will soon be included in [Cadbury, the many purpose Matrix bot](https://codeberg.org/EdTheDev/matrix-cadbury). -Chores that have not been marked completed for one day are treated as undone. - -Works well with, and is included in [Cadbury, the many purpose Matrix bot](https://codeberg.org/EdTheDev/matrix-cadbury). +Use `!fridge help`, to get started. ## Usage @@ -16,28 +17,8 @@ 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 -``` - ## Todo list -- [x] allow marking multiple items done in a comma separated list (see shop bot add or boal bot done) +