From fffc5b3893056b3736733f68b6f7654b52484194 Mon Sep 17 00:00:00 2001 From: William Kray Date: Fri, 16 Aug 2024 06:39:03 -0700 Subject: [PATCH] update readme --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 209a403..3a45f9b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ # Community Bot -a maubot plugin that attempts to assist administrators of communities on matrix, based on the concept of matrix spaces. -this bot will attempt to administer any room that it is in (specifically user activity tracking), so you may want to -leverage [join](https://github.com/williamkray/maubot-join) to ensure your bot doesn't end up somewhere it's not -supposed to be. +a maubot plugin that helps administrators of communities on matrix, based on the concept of a matrix space. this bot +will attempt to track user activity in any room that it is in, so you may want to leverage +[join](https://github.com/williamkray/maubot-join) to ensure your bot doesn't end up somewhere it's not supposed to be. # 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 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 tracks the last message timestamp of a user across any room that the bot is in, and generates a simple report. intended