README.md

   1 ## About
   2
   3 A matrix bot that tracks fridge contents.
   4
   5 Tell it what you add to the fridge with `!fridge add`,
   6 and it will track what was added and when,
   7 and will periodically remind members of the chat room
   8 to eat left-overs and/or toss food that is too old.
   9
  10 Works well with, and will soon be included in [Cadbury, the many purpose Matrix bot](https://codeberg.org/EdTheDev/matrix-cadbury).
  11
  12 Use `!fridge help`, to get started.
  13
  14 ## Usage
  15
  16 Configure the necessary environment variables, and run with `make serve`.
  17
  18 Invite the bot to a Matrix channel, and it will accept automatically, if it can.
  19
  20 > Tip: Additional setup is required to add a Matrix bot to an encrypted channel.
  21
  22 ## Todo list
  23
  24