Skip to content

Rewrite the README and sync the composer description #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bonelifer merged 1 commit into from
Sep 28, 2026
Merged

Rewrite the README and sync the composer description #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 33 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
Loading