Skip to content

docs: a README with a larger logo, a quick start and install commands… - #32

Merged
wiifree merged 1 commit into
mainfrom
docs/readme
Oct 30, 2026
Merged

wiifree merged 1 commit into
mainfrom
docs/readme

Conversation

@wiifree

@wiifree wiifree commented Oct 30, 2026

Copy link
Copy Markdown
Member

… for npm, pnpm, Yarn and Bun

  • Centred header with the logo at 160 px, tagline, links (Storybook, quick start, components, llms.txt, contributing) and badges
  • Highlights; quick start in three steps with the Vite plugin for a smaller CSS file and the same example in Vue and React
  • Link to the public Storybook; component overview and subpath table in collapsible sections; the PDF viewer setup points to the guide
  • Package READMEs and the guide "Getting started": npm, pnpm, Yarn and Bun (React Native: also npx expo install); regenerated MCP data

What and why

Checklist

  • Vue and React with an identical API and identical DOM (parity case in packages/parity/src/cases.ts)
  • Accessibility according to WCAG 2.2 AA – keyboard, focus, names, states (rules in docs/accessibility.md, workflow in CONTRIBUTING.md)
  • Stories in both Storybooks, texts in English
  • Tests: pnpm lint, pnpm typecheck, pnpm test (targeted E2E specs for interaction)
  • AI docs updated (pnpm --filter @wirecore/wirelayer-mcp collect), changeset added (pnpm changeset)
  • New dependencies: license on the allowlist (pnpm licenses:check), optional as a peerDependency
  • All commits with Signed-off-by (git commit -s, DCO)

… for npm, pnpm, Yarn and Bun

- Centred header with the logo at 160 px, tagline, links (Storybook, quick
  start, components, llms.txt, contributing) and badges
- Highlights; quick start in three steps with the Vite plugin for a
  smaller CSS file and the same example in Vue and React
- Link to the public Storybook; component overview and subpath table in
  collapsible sections; the PDF viewer setup points to the guide
- Package READMEs and the guide "Getting started": npm, pnpm, Yarn and
  Bun (React Native: also npx expo install); regenerated MCP data

Signed-off-by: Florian Laabs <florian.laabs@wirecore.net>
@wiifree
wiifree merged commit 9dab003 into main Oct 30, 2026
18 checks passed
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