Skip to content

Add a banner and badges to the README - #45

Merged
WilyFoxM merged 1 commit into
mainfrom
docs/readme-banner
Nov 7, 2026
Merged

WilyFoxM merged 1 commit into
mainfrom
docs/readme-banner

Conversation

@WilyFoxM

@WilyFoxM WilyFoxM commented Nov 7, 2026

Copy link
Copy Markdown
Owner

Problem and resulting behavior

The README opened with plain text. It now starts with the project banner and a row of badges, as on the mod page.

  • docs/banner.webp: the banner image, 2000×500, added unchanged.
  • Badges from shields.io, in the project palette: latest GitHub release and the Build workflow on main, which update themselves, and static ones for Minecraft 26.2, Fabric and Java 25, which need editing when the supported versions change.

The text of the README is unchanged.

Validation performed

  • GitHub checks (build, unit-tests, spotless): pending on this PR.
  • Local checks actually run (configuration and result): fetched the release, build and Minecraft badge URLs; they return "release: v1.6.0", "build: passing" and "Minecraft: 26.2". Viewed the README on this branch on GitHub in the dark theme: the banner and badges render above the title.
  • Rendering screenshots / benchmark evidence, where relevant: none.

Limits and compatibility

Not viewed in the light theme. No Modrinth badge: while the project is under review, its public API returns 404.

@WilyFoxM
WilyFoxM merged commit 6a19f53 into main Nov 7, 2026
6 checks passed
@WilyFoxM
WilyFoxM deleted the docs/readme-banner branch November 7, 2026 08:18
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