From f01ece22a3c65b6ae4c1d62b1914b0f90bc070c2 Mon Sep 17 00:00:00 2001
From: Declan Chidlow <84255570+DeclanChidlow@users.noreply.github.com>
Date: Fri, 22 Mar 2024 21:29:14 +0800
Subject: [PATCH] Updated README
Setup for new era of the project
---
README.md | 51 +++++++++++++++++++++++----------------------------
1 file changed, 23 insertions(+), 28 deletions(-)
diff --git a/README.md b/README.md
index 7243442..de45cec 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,27 @@
-# AutoMod
+
+
+ AutoMod
+
+ [![Stars](https://img.shields.io/github/stars/DeclanChidlow/AutoMod?style=flat-square&logoColor=white)](https://github.com/DeclanChidlow/AutoMod/stargazers)
+ [![Forks](https://img.shields.io/github/forks/DeclanChidlow/AutoMod?style=flat-square&logoColor=white)](https://github.com/DeclanChidlow/AutoMod/network/members)
+ [![Pull Requests](https://img.shields.io/github/issues-pr/DeclanChidlow/AutoMod?style=flat-square&logoColor=white)](https://github.com/DeclanChidlow/AutoMod/pulls)
+ [![Issues](https://img.shields.io/github/issues/DeclanChidlow/AutoMod?style=flat-square&logoColor=white)](https://github.com/DeclanChidlow/AutoMod/issues)
+ [![Contributors](https://img.shields.io/github/contributors/DeclanChidlow/AutoMod?style=flat-square&logoColor=white)](https://github.com/DeclanChidlowRepo/Template/graphs/contributors)
+ [![Licence](https://img.shields.io/github/license/DeclanChidlow/AutoMod?style=flat-square&logoColor=white)](https://github.com/DeclanChidlow/AutoMod/blob/main/LICENCE)
+
+Moderation bot for Revolt Chat
+
+
-The best moderation bot for Revolt! \
-Or so they say...
-
-[](https://rvlt.gg/jan)
-
-[](https://app.revolt.chat/bot/01FHGJ3NPP7XANQQH8C2BE44ZY)
-
-AutoMod aims to protect your community from spam and malicious actors. It offers powerful moderation tools, an infraction system, a web interface and in the future will be able to automatically prevent raids and ban malicious actors.
-
-
+AutoMod aims to protect your community from spam and malicious actors. It offers powerful moderation tools, an infraction system, and a web interface.
## Features
+* Basic moderation features, including kick, ban, warn, purge, and timeout
+* Infraction system, which logs all moderation events
+* Configurable antispam rules
+* Web interface for easy configuration
+* Fully configurable bot prefix
+* Permission system for moderation commands
-- Basic moderation features: Kick/Ban/Tempban/Warn
-- Infraction system which logs all moderation events
-- Rudamentary configurable antispam rules (If user sends more than X messages per Y seconds, delete/warn/send message)
-- Web interface for easy configuration
-- Fully configurable bot prefix
-- Permission system for moderation commands
-- Votekick system to allow trusted users to remove users while no moderator is available*
-- Act on messages based on regex matches (delete/warn/send message)*
-- Log moderation events, message edits and deletions to a Revolt channel or Discord Webhook*
-- Scan user profiles and alert moderators of suspicious users (Wordlist is private and provided by the bot admin)*
-- And more is planned!
-
-\* Technically a feature, but not yet configurable without database access. If you would like to set any of these up right now, feel free to get in contact with me.
-
-## Donations
-
-If you want to support this project, check out [this page](https://janderedev.xyz/donate). If you don't want to help financially, feel free to join [my server](https://rvlt.gg/jan) and provide mental support in the form of catgirls instead!
+## Add the bot
+What are you waiting for? Simply click [this link](https://app.revolt.chat/bot/01FHGJ3NPP7XANQQH8C2BE44ZY) to add the bot to your server.