X-Git-Url: https://apps.delaporte.us/gitweb/matrix-cadbury.git/blobdiff_plain/caa0cd11f78960cf0b97008f3bbe3742db402d8c..92d06b0637338b1df9abe36c73a731c2b9fe6112:/README.md diff --git a/README.md b/README.md index 3a7d40b..e28db46 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,20 @@ Cadbury is a friendly composable multi-purpose Matrix bot. -See `pyproject.toml` for the dependencies, and not that each is a separate dedicated bot role. Bots roles are composed in `app.py` before connecting to the Matrix server. +See `pyproject.toml` for the dependencies. +Note that each dependency provides a separate dedicated bot role. +Bots roles are composed in `app.py` before connecting to the Matrix server. Although each bot role can run separately with separate credentials, the purpose of `Cadbury` is to compose several together under a single Matrix bot login. +## Remixing + +When creating your own unique mix of bot roles, consider creating a public fork of +this repository and modifying `app.py` and `pyproject.toml` as needed. + +Note that the AGPLv3 license, and please share your own modifications publicly, if you choose to use a modified version of this bot in a public setting. + ## About the Name Named for Cadbury C. Cadbury, or Herbert Arthur Runcible Cadbury.