Skip to content

Commit 91c458b

Browse files
boneliferclaude
andauthored
Rewrite the README and sync the composer description (#5)
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 <noreply@anthropic.com>
1 parent 4403883 commit 91c458b

2 files changed

Lines changed: 32 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
11
# Insert Iconify Script
22

3-
Loads the [Iconify](https://iconify.design/) script before `</body>` on every page, so Iconify icons can be used in templates and posts.
3+
[![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)
44

5-
## Installation
5+
Loads the Iconify icon script on every page so Iconify icons can be used in templates and posts.
6+
7+
## Features
8+
9+
- Adds the [Iconify](https://iconify.design/) 3 script before `</body>` on every page.
10+
- No settings: enable it and use Iconify markup, e.g. `<span class="iconify" data-icon="mdi:home"></span>`, in templates or posts that allow HTML.
611

7-
Copy the extension to `phpBB/ext/phpbbmodders/inserticonifyscript`.
12+
## Requirements
13+
14+
- phpBB 3.3.0 or later
15+
- PHP 7.4 or later
16+
17+
## Installation
818

9-
Go to "ACP" > "Customise" > "Extensions" and enable the "Insert Iconify Script" extension.
19+
1. Copy the extension to `/ext/phpbbmodders/inserticonifyscript`
20+
2. In the Administration Control Panel, go to **Customise → Manage extensions**
21+
3. Enable the **Insert Iconify Script** extension
1022

1123
### Upgrading from `modders/inserticonifyscript`
1224

@@ -19,6 +31,20 @@ This extension was previously published as `modders/inserticonifyscript`. To swi
1931

2032
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.
2133

34+
## Contributing
35+
36+
Contributions are welcome!
37+
38+
- **Bug reports**: [Open an issue](https://github.com/phpbbmodders/inserticonifyscript/issues).
39+
- **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/).
40+
- Pull requests are welcome for bug fixes or discussed features.
41+
42+
## Acknowledgments
43+
44+
- Code review, bug fixes, and documentation assisted by [Claude](https://www.anthropic.com/claude).
45+
2246
## License
2347

24-
[GPLv2](license.txt)
48+
This extension is licensed under the **GNU General Public License v2.0**.
49+
50+
See [license.txt](license.txt) for more information.

‎composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "phpbbmodders/inserticonifyscript",
33
"type": "phpbb-extension",
4-
"description": "PHPBB Extension to insert Iconify script before </body>.",
4+
"description": "Loads the Iconify icon script on every page so Iconify icons can be used in templates and posts.",
55
"homepage": "https://www.phpbbmodders.com/",
66
"version": "1.0.0-dev",
77
"time": "2024-05-28",

0 commit comments

Comments
 (0)