diff options
author | Arjun Satarkar <me@arjunsatarkar.net> | 2024-05-15 15:34:54 +0000 |
---|---|---|
committer | Arjun Satarkar <me@arjunsatarkar.net> | 2024-05-15 15:34:54 +0000 |
commit | db8d2349175db503f2ce889a9928b22a3067b30c (patch) | |
tree | b52ef936ec1324a6df73181ed21a57e1512af761 | |
parent | 615cfe09a3daa29c43eca0dd88d035600e521321 (diff) | |
download | aps-cogs-db8d2349175db503f2ce889a9928b22a3067b30c.tar aps-cogs-db8d2349175db503f2ce889a9928b22a3067b30c.tar.gz aps-cogs-db8d2349175db503f2ce889a9928b22a3067b30c.zip |
Add more information to README
-rw-r--r-- | README.adoc | 24 |
1 files changed, 23 insertions, 1 deletions
diff --git a/README.adoc b/README.adoc index dc9842b..c80cb06 100644 --- a/README.adoc +++ b/README.adoc @@ -1,3 +1,25 @@ = aps-cogs -My cogs for the https://docs.discord.red/en/stable/[Red] self-hosted https://discord.com/[Discord] bot. +Discord bot cogs using the Red framework. + +== What's In This Repo + +=== Markov + +Creates https://en.wikipedia.org/wiki/Markov_chain[Markov chains] based on users and guilds. Tokenization +handles URLs, emoji (including custom emoji), and mentions correctly. The data is stored in an SQLite database +and both insertion and generation are performant even with large datasets. + +=== Question of the Day + +Post a question to a designated channel daily; questions can be added by mods and suggested by users. Supports ergonomic +create-read-update-delete features to make it easy to manage for moderators. + +=== Teleport + +Allows users to create a portal between two channels at a given point so a conversation can be moved without losing continuity. + +=== Pin Delegate + +Delegate permission to pin messages in a channel or thread (using a command) without needing to grant user rights with a +broader scope. |