docs: add project logo to readme header#241
Merged
Merged
Conversation
place a centered logo above the existing H1 so the repo has a distinct visual identity at first glance. the H1 stays in place to preserve both screen-reader accessibility and the existing SEO signal for the descriptive title.
the logo only renders meaningfully when the readme is viewed on github; downstream consumers reading the unpacked readme from their vendor/ directory don't benefit from the image, so trim it out of the tarball to keep the shipped package focused on code.
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.
Summary
Add
images/logo.pngand embed it centered above the existing H1 inREADME.mdso the repo has a distinct visual identity at first glance.Why
The README currently opens with badges only — no visual anchor. A logo above the H1 (Pest / Spatie / Tailwind-style) gives a faster brand recognition signal for visitors coming from social shares, listings, and search results, without sacrificing the descriptive H1 that screen readers and search indexers rely on.
Verification
<p align="center">block resolves to a centered image on github.com.images/directory is not incomposer.json→archive.exclude, so the logo also ships inside the Packagist tarball — keeping the README functional anywhere the package is unpacked.Notes for reviewers
width="480"while the source is 1774×887, so the asset stays crisp on retina displays.# OpenAPI Contract Testing for PHPUnit) is intentionally retained beneath the logo. Removing it would degrade screen-reader and SEO behavior with no visual benefit.