From 6001f5bf1a9dc2a566811c8a41a9435b1d12edd8 Mon Sep 17 00:00:00 2001 From: William Kray Date: Sat, 19 Oct 2024 16:53:23 -0700 Subject: [PATCH] update readme to point to base-config comments which are a better source of documentation of features --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f32f6a1..93d606e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # Community Bot [![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 -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. +a maubot plugin that helps administrators of communities on matrix, based on the concept of a matrix space. 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. # should i use this? @@ -32,6 +32,9 @@ Draupnir or Mjolnir. # 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 configure your bot to send a custom greeting to users whenever they join a room! configuration file provides a greeting