From 9f284bd97b6aa34884845d5ede8fa5c82e409236 Mon Sep 17 00:00:00 2001 From: William Jacoby Date: Sun, 27 Sep 2026 20:17:32 -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 | 36 +++++++++++++++++++++++++++++++----- composer.json | 2 +- 2 files changed, 32 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 50423ee..8d72a37 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,24 @@ # Insert Iconify Script -Loads the [Iconify](https://iconify.design/) script before `` on every page, so Iconify icons can be used in templates and posts. +[![Tests](https://github.com/phpbbmodders/inserticonifyscript/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbbmodders/inserticonifyscript/actions/workflows/tests.yml) [![Lint](https://github.com/phpbbmodders/inserticonifyscript/actions/workflows/lint.yml/badge.svg)](https://github.com/phpbbmodders/inserticonifyscript/actions/workflows/lint.yml) -## Installation +Loads the Iconify icon script on every page so Iconify icons can be used in templates and posts. + +## Features + +- Adds the [Iconify](https://iconify.design/) 3 script before `` on every page. +- No settings: enable it and use Iconify markup, e.g. ``, in templates or posts that allow HTML. -Copy the extension to `phpBB/ext/phpbbmodders/inserticonifyscript`. +## Requirements + +- phpBB 3.3.0 or later +- PHP 7.4 or later + +## Installation -Go to "ACP" > "Customise" > "Extensions" and enable the "Insert Iconify Script" extension. +1. Copy the extension to `/ext/phpbbmodders/inserticonifyscript` +2. In the Administration Control Panel, go to **Customise → Manage extensions** +3. Enable the **Insert Iconify Script** extension ### Upgrading from `modders/inserticonifyscript` @@ -19,6 +31,20 @@ This extension was previously published as `modders/inserticonifyscript`. To swi If you disable the old extension from the command line (`bin/phpbbcli.php`) instead of the ACP, run `bin/phpbbcli.php cache:purge` before enabling the new one; the command-line disable doesn't clear the cache. +## Contributing + +Contributions are welcome! + +- **Bug reports**: [Open an issue](https://github.com/phpbbmodders/inserticonifyscript/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 + +- Code review, bug fixes, and documentation assisted by [Claude](https://www.anthropic.com/claude). + ## License -[GPLv2](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 166e443..9f5942f 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "phpbbmodders/inserticonifyscript", "type": "phpbb-extension", - "description": "PHPBB Extension to insert Iconify script before .", + "description": "Loads the Iconify icon script on every page so Iconify icons can be used in templates and posts.", "homepage": "https://www.phpbbmodders.com/", "version": "1.0.0-dev", "time": "2024-05-28",