Skip to content

Rewrite the README and sync the composer description - #9

Merged
bonelifer merged 1 commit into
masterfrom
readme-refresh
Sep 28, 2026
Merged

bonelifer merged 1 commit into
masterfrom
readme-refresh

Conversation

@bonelifer

Copy link
Copy Markdown
Contributor

Summary

  • Rewrites the README in the standard phpBB Modders layout:
    • Tests and Lint status badges
    • a short feature list, written from what the code actually does
    • requirements (from composer.json) and installation steps
    • contributing (org Discussions and the community forum), acknowledgments, and the GPL v2.0 license section
  • composer.json description now matches the new one-line description, which is also the GitHub repo description.

Test plan

  • Documentation and metadata only. Claude ran composer validate, and CI runs the existing tests and lint.

Investigated and written by Claude on behalf of William Jacoby (bonelifer).

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>
@bonelifer
bonelifer merged commit c13846e into master Sep 28, 2026
7 checks passed
@bonelifer
bonelifer deleted the readme-refresh branch September 28, 2026 01:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant