From 2929499578bab0b3bc2489d40f5db470d3fb426b Mon Sep 17 00:00:00 2001 From: William Jacoby Date: Sun, 27 Sep 2026 20:17:54 -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 | 34 +++++++++++++++++++++++++++------- composer.json | 2 +- 2 files changed, 28 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c2c1096..174746e 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/composer.json b/composer.json index 8d2ab9d..10d3aba 100644 --- a/composer.json +++ b/composer.json @@ -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",