Skip to content

docs: add branded README header with Vuetify logo - #2

Open
johnleider wants to merge 1 commit into
masterfrom
cursor/add-branded-readme-header-b3c5
Open

johnleider wants to merge 1 commit into
masterfrom
cursor/add-branded-readme-header-b3c5

Conversation

@johnleider

Copy link
Copy Markdown
Member

Summary

Add a brand header to the README matching the pattern used in other Vuetify repositories (vuetifyjs/vuetify, vuetifyjs/ecosystem):

  • Centered <picture> element with light/dark Vuetify logo from cdn.vuetifyjs.com
  • GPL-3.0 license shield (matching this repo's actual license)
  • Discord invite widget shield (https://discord.gg/vuetify)

The existing screenshot is preserved in the body of the README. No npm version/downloads badges were added since the pkg-diff npm package belongs to a different project (nipher/pkg-diff).

Test plan

  1. Verified README renders correctly with the new header
  2. Confirmed license badge links to the correct GPL-3.0 LICENSE file
  3. Confirmed Discord widget shield links to the Vuetify Discord
  4. Ran lint: pnpm lint passes
  5. Ran build: pnpm build passes
  6. Ran tests: pnpm test passes (17 tests, requires Node 24+)
Open in Web Open in Cursor 

Add a brand header to match other Vuetify repos:
- Centered light/dark Vuetify logo from CDN
- GPL-3.0 license shield
- Discord invite shield

Keep the existing screenshot in the body.

Co-authored-by: John Leider <[email protected]>
@johnleider johnleider added the documentation Improvements or additions to documentation label Oct 3, 2026 — with Cursor
@johnleider johnleider self-assigned this Oct 3, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants