feat(branding): add a README banner - #16
Merged
Merged
Conversation
biome.json still pointed at the 2.3.11 schema after the bump to 2.5.12, which biome itself reports as an info diagnostic on every run.
The README is the entire npm listing — npm has no package icon field — so this is the only branding surface the package has. Plain CommonMark image syntax with an absolute raw.githubusercontent.com URL: relative paths do not resolve once the package is installed from the registry, and npm sanitises raw HTML, so a centred <p> wrapper is not reliable. The banner is 1280px wide, quantised to a 128-colour palette with dithering — around 250 KB rather than the 1.3 MB source, with no visible banding.
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
1 participant
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.
The README is the entire npm listing — npm has no package icon field — so this is the only branding surface the package has.
Two details that matter, because both would silently render nothing:
<p>wrapper. npm sanitises raw HTML in READMEs, so the wrapper isn't reliable.raw.githubusercontent.comURL. Relative paths don't resolve once the package is installed from the registry.The banner is 1280px wide, quantised to a 128-colour palette with dithering — around 250 KB instead of the 1.3 MB source, with no visible banding (I compared crops before committing).
Also folds in a one-line fix:
biome.jsonstill pointed at the 2.3.11 schema after the bump to 2.5.12, which biome reports as an info diagnostic on every run. Bundled here rather than spending a separate PR on it.The banner appears on GitHub immediately and on npm from the next publish.