Skip to content

Rewrite the README and sync the composer description #3

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 #3

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
34 changes: 27 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,39 @@
# User ID in Viewtopic

Adds the user id in viewtopic.
[![Tests](https://github.com/phpbbmodders/useridviewtopic/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbbmodders/useridviewtopic/actions/workflows/tests.yml) [![Lint](https://github.com/phpbbmodders/useridviewtopic/actions/workflows/lint.yml/badge.svg)](https://github.com/phpbbmodders/useridviewtopic/actions/workflows/lint.yml)

Shows each poster's user ID next to their posts.

## Features

- The poster's user ID appears under their rank on topic pages.
- On/off switch: **ACP → General → Load settings → Display user id on topic pages**.

## Requirements

- phpBB 3.3.17 or later
- PHP 8.2 or later

## Installation

1. Copy the extension to: `/ext/phpbbmodders/useridviewtopic`
2. In the Administration Control Panel, navigate to: **Customise → Manage extensions**
1. Copy the extension to `/ext/phpbbmodders/useridviewtopic`
2. In the Administration Control Panel, go to **Customise → Manage extensions**
3. Enable the **User ID in Viewtopic** extension

## Automated testing
## Contributing

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/useridviewtopic/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/useridviewtopic/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbbmodders/useridviewtopic/actions/workflows/tests.yml)
## Acknowledgments

- 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/useridviewtopic",
"type": "phpbb-extension",
"description": "Adds the user id in viewtopic.",
"description": "Shows each poster's user ID next to their posts.",
"homepage": "https://www.phpbbmodders.com/",
"version": "1.0.0-dev",
"time": "2026-05-28",
Expand Down
Loading