From ebdb9b8a5832fc17b82542da2d59421f00ed7003 Mon Sep 17 00:00:00 2001 From: William Jacoby Date: Sun, 27 Sep 2026 20:17:17 -0500 Subject: [PATCH] Rewrite the README and sync the composer description Standard phpBB Modders README layout: status badges, a short feature list, requirements, installation, contributing (org Discussions and the community forum), acknowledgments and the GPL v2.0 license section. The one-line description now matches the GitHub repo description. Co-Authored-By: Claude Opus 5.5 --- README.md | 40 +++++++++++++++++++++++++++++++++------- composer.json | 2 +- 2 files changed, 34 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e01d4e4..8b25c2d 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,45 @@ # Add User -Allows administrators to add users to their board. +[![Tests](https://github.com/phpbbmodders/adduser/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbbmodders/adduser/actions/workflows/tests.yml) [![Lint](https://github.com/phpbbmodders/adduser/actions/workflows/lint.yml/badge.svg)](https://github.com/phpbbmodders/adduser/actions/workflows/lint.yml) + +Lets administrators create user accounts from the ACP. + +## Features + +- New **Add User** page under **ACP → Users and Groups**. +- Set username, email, password (left blank, one is generated), language and birthday. +- Choose the user's group and optionally make it their default group; optionally add them to *Newly registered users*. +- Follows the board's activation setting: the new user gets their login details by email, or with admin activation you can activate the account on the spot. +- Every account created is recorded in the admin log. + +## Requirements + +- phpBB 3.3.19 or later +- PHP 8.0 or later ## Installation -1. Copy the extension to: `/ext/phpbbmodders/adduser` -2. In the Administration Control Panel, go to: **Customise → Manage extensions** +1. Copy the extension to `/ext/phpbbmodders/adduser` +2. In the Administration Control Panel, go to **Customise → Manage extensions** 3. Enable the **Add User** extension +4. Add users under **ACP → Users and Groups → Add User** + +## Contributing -## Automated testing +Contributions are welcome! -We use automated unit tests to prevent regressions. Check out our build below: +- **Bug reports**: [Open an issue](https://github.com/phpbbmodders/adduser/issues). +- **Everything else** (questions, feature requests, ideas, general discussion): [Use Discussions](https://github.com/orgs/phpbbmodders/discussions), or the [community forum](https://www.phpbbmodders.com/community/). +- Pull requests are welcome for bug fixes or discussed features. -[![Tests](https://github.com/phpbbmodders/adduser/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbbmodders/adduser/actions/workflows/tests.yml) +## Acknowledgments + +- Based on the phpBB 3.0 **ACP Add User** MOD by phpbbmodders.net. +- Ported to phpBB 3.1 by Rich McGirr ([RMcGirr83](https://github.com/rmcgirr83)) and tumba25. +- Code review, bug fixes, and documentation assisted by [Claude](https://www.anthropic.com/claude). ## License -Licensed under the [GNU General Public License v2](license.txt) +This extension is licensed under the **GNU General Public License v2.0**. + +See [license.txt](license.txt) for more information. diff --git a/composer.json b/composer.json index 9532c26..aec7c88 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "phpbbmodders/adduser", "type": "phpbb-extension", - "description": "Allows administrators to add users to their board.", + "description": "Lets administrators create user accounts from the ACP.", "homepage": "https://www.phpbbmodders.com/", "version": "1.0.5", "time": "2026-09-28",