Skip to content

docs: add badge group, branded badges, and logo to README#33

Merged
jal-co merged 1 commit into
mainfrom
docs/readme-badges
May 31, 2026
Merged

docs: add badge group, branded badges, and logo to README#33
jal-co merged 1 commit into
mainfrom
docs/readme-badges

Conversation

@jal-co

@jal-co jal-co commented May 31, 2026

Copy link
Copy Markdown
Owner

What

Restyles the README header to match the shieldcn pattern: a centered logo, a nav row, a single badge group, and a couple of branded standalone badges.

Why

The header was a bare # scn-stack H1 plus four loose badges. This gives it a polished, on-brand landing that matches the shieldcn / jal-co house style and surfaces the key stats in one clean image.

Closes #

Type

  • docs — Documentation

How

  • Logo — the existing www/public/brand/repo-header.png (the scn=stack wordmark), centered and linking to scnstack.sh.
  • Nav row — Homepage · Docs · Builder · 𝕏.
  • Badge group — one joined shieldcn image (/group/...+...) with stars, npm version, monthly downloads, and license, variant=branded.
  • Standalone badges — kept deliberately small: "built with shadcn" and "made by Justin Levine".

All URLs verified: each badge endpoint returns 200 image/svg+xml, the raw logo returns 200 image/png (the file already lives on main), and the rendered output was checked visually.

Testing

  • commit-check --branch / --message — pass
  • Badge + logo URLs return 200 and render correctly
  • No code changed.

Screenshots

Badge group renders as: ★ stars · npm version · downloads/month · license in the branded (shadcn-styled) variant, plus the centered scn=stack logo above it.

Restyles the README header to match the shieldcn pattern:

- Centered scn=stack logo (existing repo-header.png) linking to the
  homepage
- Homepage / Docs / Builder / X nav row
- A single shieldcn badge group joining stars, npm version, downloads,
  and license into one branded image
- Two standalone branded badges (built with shadcn, made by Justin
  Levine)

Replaces the previous four loose badges and the bare H1 with the logo.
@vercel

vercel Bot commented May 31, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
scn-stack Ready Ready Preview, Comment May 31, 2026 3:02am

Request Review

@github-actions github-actions Bot added the docs Documentation changes label May 31, 2026
@jal-co jal-co merged commit 111afca into main May 31, 2026
5 checks passed
@jal-co jal-co deleted the docs/readme-badges branch May 31, 2026 03:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant