update readme
This commit is contained in:
@@ -1,9 +1,8 @@
|
|||||||
# Community Bot
|
# Community Bot
|
||||||
|
|
||||||
a maubot plugin that attempts to assist administrators of communities on matrix, based on the concept of matrix spaces.
|
a maubot plugin that helps administrators of communities on matrix, based on the concept of a matrix space. this bot
|
||||||
this bot will attempt to administer any room that it is in (specifically user activity tracking), so you may want to
|
will attempt to track user activity in any room that it is in, so you may want to leverage
|
||||||
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.
|
|
||||||
|
|
||||||
# features
|
# features
|
||||||
|
|
||||||
@@ -13,6 +12,11 @@ configure your bot to send a custom greeting to users whenever they join a room!
|
|||||||
map (define multiple greetings each with an identifier) and then a configuration of which rooms to greet users in, and
|
map (define multiple greetings each with an identifier) and then a configuration of which rooms to greet users in, and
|
||||||
which greeting message the bot should send them.
|
which greeting message the bot should send them.
|
||||||
|
|
||||||
|
Configure a `notification_room` to receive messages when someone joins one of the greeting rooms. If you just want
|
||||||
|
notifications (perhaps when someone joins the space, where the bot likely cannot send a greeting anyway) set the
|
||||||
|
greeting name to `'none'` in the greeting map, and the bot will skip the greeting and send a notification to your
|
||||||
|
notification room.
|
||||||
|
|
||||||
## activity tracking and reporting
|
## activity tracking and reporting
|
||||||
|
|
||||||
tracks the last message timestamp of a user across any room that the bot is in, and generates a simple report. intended
|
tracks the last message timestamp of a user across any room that the bot is in, and generates a simple report. intended
|
||||||
|
|||||||
Reference in New Issue
Block a user