]> apps.delaporte.us Git - matrix-cadbury.git/commitdiff
Add README
authorEdward Delaporte <edward@delaporte.us>
Sat, 28 Mar 2026 00:31:38 +0000 (19:31 -0500)
committerEdward Delaporte <edward@delaporte.us>
Sat, 28 Mar 2026 00:31:38 +0000 (19:31 -0500)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..3a7d40b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+## About
+
+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.
+
+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.
+
+## About the Name
+
+Named for Cadbury C. Cadbury, or Herbert Arthur Runcible Cadbury.
+
+    The Riches' butler who attends to the Rich estate. British born, Cadbury gives the image of propriety and service. When need demands however, he becomes a tough, man of action. Cadbury is also a master hypnotist, ventriloquist and wood-carver.
+
+