README.md

   1 ## About
   2
   3 A matrix bot that tracks daily chore completion.
   4
   5
   6 Add a list of chores, and tell the bot when they are done.
   7 Ask the bot for status of the list.
   8
   9 Chores that have not been marked completed for one day are treated as undone.
  10
  11 Works well with, and is included in [Cadbury, the many purpose Matrix bot](https://codeberg.org/EdTheDev/matrix-cadbury).
  12
  13 ## Usage
  14
  15 Configure the necessary environment variables, and run with `make serve`.
  16
  17 Invite the bot to a Matrix channel, and it will accept automatically, if it can.
  18
  19 Use `!chore help`, to get started.
  20
  21 > Tip: Additional setup is required to add a Matrix bot to an encrypted channel.
  22
  23 ```
  24 !chore help
  25
  26 Prefix: !chore
  27
  28     Synax:
  29         !chore COMMAND ARGS
  30
  31     Commands:
  32       help - show this help
  33       add - add a daily chore
  34       check - check status of a chore
  35       done - mark a chore as done
  36       list - print the daily chore list (including status)
  37       undo - mark a chore as undone
  38       remove - remove a daily chore
  39 ```
  40