diff --git a/README.md b/README.md index 2381532..9b820f5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,15 @@ # ban-hammer Ban Hammer for phpBB 3.3.x line (was One Click Ban) -Gives possibility to ban users directly from their profile. Along with banning you can automatically move the user to a certain group, delete their posts, delete their private messages, delete their avatar, signature, and profile information. +Gives moderators a one-click way to ban a user directly from their profile or from the MCP post-approval queue: ban the username, email, and/or IP, delete their posts, private messages, avatar, signature, and profile fields, optionally move them into a group, and optionally report them to Stop Forum Spam. As an alternative to banning outright, a moderator can instead restrict a user into a heavily-limited group for a set time (or permanently), with their original group automatically restored once the restriction expires. A "Ban email domain" action is also available from the MCP approve-details page. + +Requires PHP 7.4+ and phpBB 3.3.17+. + +## Installation + +1. Copy (or clone) this extension to `phpBB/ext/phpbbmodders/banhammer`. +2. In the ACP, go to Customise → Manage Extensions and enable Ban Hammer. +3. Configure it under ACP → Ban Hammer: what a ban deletes, an optional group to move banned users into, an optional group to restrict users into instead of banning, ban length options, and (optionally) a Stop Forum Spam API key. ## Automated testing