Status badge for README / dashboards

Why you need it

Most status pages live behind a link nobody clicks until the site's already broken. A badge is a status page you can put where customers already look — your homepage, your docs, your README — without re-platforming.

• One URL, infinite embed points. Every StatusPulse page exposes /badge.svg that returns a fresh shield-style SVG cached at 60 s.
• Five status messages, five colours. Operational (brand green), degraded (amber), major outage (coral), maintenance (blue), unknown (grey). Same rollup logic as the public page header — never two surfaces disagreeing.
• Shields.io endpoint too. /badge.json implements the shields.io endpoint v1 schema so callers who prefer their renderer / CDN get the same colour-mapped chip with their own polish.
• Copy-paste snippets in the dashboard. Pre-formatted Markdown + HTML pasted into the Help docs for the slug you actually use — no string interpolation in your head.

Where it pays off

Embed wherever customer eyes land before your status page:

• Project README on GitHub. One image link next to your build / license / Codecov badges — outage status becomes part of project hygiene.
• Customer-facing docs. Top of a "Service health" page so support requests start with "I see this is degraded" instead of "is it just me?".
• Internal dashboards. Grafana / Notion / Confluence wikis — anywhere your team already lives, without a separate tab to remember.
• Marketing landing. Small "All systems operational" pill in the footer; reads as both confidence-builder and accountability move.

Not the right tool when: you need rich incident text or subscriber sign-up — use the full status page or the embed widget; the badge is one pixel of context.

Related

• Embeddable status widget
• Status pages
• Public trust score