From 69e939a02b3a31f810f031575a451fd636d1e6ae Mon Sep 17 00:00:00 2001 From: William Jacoby Date: Sun, 27 Sep 2026 20:17:36 -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 | 46 ++++++++++++++++++++++++++++++++++------------ composer.json | 2 +- 2 files changed, 35 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 44d5ea4..68f6c6d 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,42 @@ -phpbb-3.1-annualstars -========================= +# Annual Stars -Extension will display stars for the number of years a user has been registered on a forum. +[![Tests](https://github.com/phpbbmodders/phpbb-3.1-annualstars/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbbmodders/phpbb-3.1-annualstars/actions/workflows/tests.yml) [![Lint](https://github.com/phpbbmodders/phpbb-3.1-annualstars/actions/workflows/lint.yml/badge.svg)](https://github.com/phpbbmodders/phpbb-3.1-annualstars/actions/workflows/lint.yml) -This extension is the 3.1.x version of the 3.0.x Annual Stars Mod](https://www.phpbb.com/customise/db/mod/annual_stars_2/) +Shows a star for each year a member has been registered, on their posts and profile. + +## Features + +- One star per full year of membership, next to each post and on the member's profile. +- Hovering a star shows "N years of membership". +- No settings. + +## Requirements + +- phpBB 3.3.19 or later +- PHP 7.4 or later ## Installation -### 1. clone -Clone (or download and move) the repository into the folder ext/phpbbmodders/annualstars: +1. Copy the extension to `/ext/phpbbmodders/annualstars` +2. In the Administration Control Panel, go to **Customise → Manage extensions** +3. Enable the **Annual Stars** extension + +## Contributing + +Contributions are welcome! + +- **Bug reports**: [Open an issue](https://github.com/phpbbmodders/phpbb-3.1-annualstars/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. + +## Acknowledgments + +- Based on the phpBB 3.0 **Annual Stars** MOD by phpbbmodders.net (co-authors Kailey and bonelifer; contributors RMcGirr83, Sniper_E, igorw and tumba25). +- Ported to phpBB 3.1 by Rich McGirr ([RMcGirr83](https://github.com/rmcgirr83)). +- Code review, bug fixes, and documentation assisted by [Claude](https://www.anthropic.com/claude). -``` -cd phpBB3 -git clone https://github.com/phpbbmodders/phpbb-3.1-annualstars.git ext/phpbbmodders/annualstars/ -``` +## License -### 2. activate -Go to admin panel -> tab customise -> Manage extensions -> enable Annual Stars +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 2be3cb8..0ccd2ba 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "phpbbmodders/annualstars", "type": "phpbb-extension", - "description": "Displays stars based on a users registration date", + "description": "Shows a star for each year a member has been registered, on their posts and profile.", "homepage": "https://www.phpbbmodders.com/", "version": "1.0.2", "time": "2017-02-14",