Skip to content

Rewrite the README and sync the composer description #5

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

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
36 changes: 31 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
# Insert Iconify Script

Loads the [Iconify](https://iconify.design/) script before `</body>` 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 `</body>` on every page.
- 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.

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`

Expand All @@ -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.
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/inserticonifyscript",
"type": "phpbb-extension",
"description": "PHPBB Extension to insert Iconify script before </body>.",
"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",
Expand Down
Loading