Fixup

[matrix-cadbury.git] / README.md

diff --git a/README.md b/README.md
index 1b48dfdbecfffbdc0f884b0c0214b9a600f8dba1..a18c5c1d7c4e2836d9d655da42a4157f6e40a905 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,6 +13,10 @@ the purpose of `Cadbury` is to compose several together under a single Matrix bo
 
 Create a bot account on your Matrix server, and set the necessary environment variables: `MATRIX_SERVER`, `MATRIX_BOT`, `MATRIX_BOT_PWD`.
 
 
 Create a bot account on your Matrix server, and set the necessary environment variables: `MATRIX_SERVER`, `MATRIX_BOT`, `MATRIX_BOT_PWD`.
 

+Set `MATRIX_DATA_DIR` to an existing directory path where you would like Cadbury to store any `sqlite3` databases.
+
+Ensure that `python` and `sqlite3` are installed and available on the path.
+

 > Tip: Cadbury has no use for email. Your Matrix server may allow creating the bot account without an email account, using a `token` registration type.
 
 Run the bot with `make serve`,
 > Tip: Cadbury has no use for email. Your Matrix server may allow creating the bot account without an email account, using a `token` registration type.
 
 Run the bot with `make serve`,


@@ -27,6 +31,22 @@ Then use the following command to launch the bot:
 
        .venv/bin/python app.py
 
 
        .venv/bin/python app.py
 

+## Chatting
+
+Invite you Cadbury bot to a Matrix channel, and it will accept automatically, if it can.
+
+> Tip: Additional setup is required to add a Matrix bot to an encrypted channel.
+
+Use `!goal help` and `!chore help`, to get started.
+
+> Tip: Many bot roles require creating a sqlite3 database, and may require you to tell Cadbuary something like `!chore setup` one initial time to create the database file.
+
+## Backups
+
+Data is stored in sqlite3 files in `MATRIX_DATA_DIR`.
+Everything Cadbuary knows is stored here.
+The files found here can be explored or modified with any `sqlite3` client.
+

 ## Remixing
 
 When creating your own unique mix of bot roles, consider creating a public fork of
 ## Remixing
 
 When creating your own unique mix of bot roles, consider creating a public fork of