docs(readme): refresh intro pitch + 19.x feature callouts#1426
Merged
Conversation
Intro - Drop the abstract "tree-shaking support" line in favour of a concrete capability pitch — post-processing effects, custom shaders, 3D mesh support, polygon-accurate physics, modern Tiled workflows, and high performance, all in just over 100 KB. - Tightened maintainer line. Camera - Mention mask-based transition effects (MaskEffect) alongside shake / fade / flash. - Add per-camera post-processing pipeline + ColorMatrix grading. Graphics - Note multi-pass chaining via `postEffects` next to the built-in shader effect list. Core - Surface the `Application` class as the modern entry point with pause / resume / freeze (hit-stop) primitives. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Refreshes the README’s introductory pitch and feature bullets to better reflect melonJS 19.x capabilities and the current recommended entry point.
Changes:
- Updates the README intro paragraph to a more concrete feature-focused capability pitch.
- Adjusts maintainer attribution wording.
- Updates feature bullets for Graphics, Camera, and Core to call out 19.x additions (postEffects chaining, per-camera post-processing/color grading,
Applicationpause/resume/freeze).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Add a comment in the workflow header explaining why docs-only PRs may end up BLOCKED if `lint` / `test` are required status checks. The proper fix is a status-check shim workflow with matching job names — left for a follow-up. (This commit also exists to force CI to run on a docs-only PR that got stuck under exactly the situation it documents.) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced Apr 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README intro was last meaningfully updated before the 18.0 → 19.x feature push (post-processing pipeline, 3D mesh, shader effects, hit-stop, multi-camera post-processing). This refresh:
postEffectschainingApplicationclass entry point withpause/resume/freeze(hit-stop)The phrasing stays approachable for hobbyists ("post-processing effects", "custom shaders") while signalling the depth pros expect — and "polygon-accurate physics" is honest about what the SAT-based system actually does without overpromising rigid-body simulation.
Diff size
1 file, +6/-4. Pure documentation, no code changes.
🤖 Generated with Claude Code