Dome/Advanced-Community-Bot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme to point to base-config comments which are a better source of documentation of features

Browse Source
This commit is contained in:
William Kray
2024-10-19 16:53:23 -07:00
parent 9631172334
commit 6001f5bf1a
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -3
View File
@@ -1,9 +1,9 @@
# Community Bot # Community Bot
[![Chat on Matrix](https://img.shields.io/badge/chat_on_matrix-%23dev:mssj.me-green)](https://matrix.to/#/#dev:mssj.me) [![Chat on Matrix](https://img.shields.io/badge/chat_on_matrix-%23dev:mssj.me-green)](https://matrix.to/#/#dev:mssj.me)
a maubot plugin that helps administrators of communities on matrix, based on the concept of a matrix space. this bot a maubot plugin that helps administrators of communities on matrix, based on the concept of a matrix space. you may want
will attempt to track user activity in any room that it is in, so you may want to leverage to leverage [join](https://github.com/williamkray/maubot-join) to ensure your bot doesn't end up somewhere it's not
[join](https://github.com/williamkray/maubot-join) to ensure your bot doesn't end up somewhere it's not supposed to be. supposed to be.
# should i use this? # should i use this?
@@ -32,6 +32,9 @@ Draupnir or Mjolnir.
# features # features
please read through the comments in the `base-config.yaml` for more thorough explanations, but this covers the high
points.
## greet new users on joining a room ## greet new users on joining a room
configure your bot to send a custom greeting to users whenever they join a room! configuration file provides a greeting configure your bot to send a custom greeting to users whenever they join a room! configuration file provides a greeting