Skip to content

Commit

Permalink
update readme to point to base-config comments which are a better sou…
Browse files Browse the repository at this point in the history
…rce of documentation of features
  • Loading branch information
williamkray committed Oct 19, 2024
1 parent 9631172 commit 6001f5b
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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?

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 6001f5b

Please sign in to comment.