diff --git a/README.md b/README.md index b40382c..9c9c9d5 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,27 @@ -phpbb-3.1-ext-editedpostsunread -=============================== +# Mark Edited Posts Unread -This extension marks topic's last posts and first post as unread if they are edited. +[![Tests](https://github.com/phpbbmodders/phpbb-3.1-ext-editedpostsunread/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbbmodders/phpbb-3.1-ext-editedpostsunread/actions/workflows/tests.yml) [![Lint](https://github.com/phpbbmodders/phpbb-3.1-ext-editedpostsunread/actions/workflows/lint.yml/badge.svg)](https://github.com/phpbbmodders/phpbb-3.1-ext-editedpostsunread/actions/workflows/lint.yml) -## Installation +Marks a topic unread again when its last post is edited. + +## Features -### 1. clone -Clone (or download and move) the repository into the folder /ext/phpbbmodders/editedpostsunread: +- Editing the last post in a topic (or the only post) moves its time to now, so the topic shows as unread for everyone. +- Edits to earlier posts are left alone. +- No settings. -``` -cd phpBB3 -git clone https://github.com/phpbbmodders/phpbb-3.1-ext-editedpostsunread.git ext/phpbbmodders/editedpostsunread/ -``` +## Requirements -### 2. activate -Go to admin panel -> tab customise -> Manage extensions -> enable Mark Edited Posts Unread +- phpBB 3.3.19 or later +- PHP 7.4 or later + +## Installation -## Upgrading from `phpbbmodders/editedposts_unread` +1. Copy the extension to `/ext/phpbbmodders/editedpostsunread` +2. In the Administration Control Panel, go to **Customise → Manage extensions** +3. Enable the **Mark Edited Posts Unread** extension + +### Upgrading from `phpbbmodders/editedposts_unread` This extension was renamed from `editedposts_unread` to `editedpostsunread` to meet phpBB's extension naming rules (no underscores). To switch an existing install: @@ -26,3 +31,22 @@ This extension was renamed from `editedposts_unread` to `editedpostsunread` to m 4. Purge the board cache. 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/phpbb-3.1-ext-editedpostsunread/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 + +- Original extension by Rich McGirr ([RMcGirr83](https://github.com/rmcgirr83)). +- Code review, bug fixes, and documentation assisted by [Claude](https://www.anthropic.com/claude). + +## License + +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 f5f49f4..0aee922 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "phpbbmodders/editedpostsunread", "type": "phpbb-extension", - "description": "Will mark posts as unread if edited", + "description": "Marks a topic unread again when its last post is edited.", "homepage": "https://www.phpbbmodders.com/", "version": "1.0.0", "time": "2014-10-28",