GitHub Badge
Embed your Sentinel security score directly in your repository's README. A live badge that shows your latest grade — updated automatically after each scan.
Live Preview
example.com · flat style
Markdown Snippet
[](https://sbscanner.pro-sub.org/methodology)How It Works
Scan Your Domain
Run a security scan on the Sentinel Scanner homepage or via the dashboard. No signup required for the first scan.
Get Your Badge URL
The badge API reads your latest scan result and generates an SVG with your grade, score, and color-coded severity.
Embed in README
Paste the markdown snippet into your README.md. The badge is served with CDN caching for fast loads.
Auto-Updates
The badge updates automatically after each new scan. No need to regenerate or update your README manually.
Badge States
| Status | Preview | Grade |
|---|---|---|
| A+Excellent | No issues | |
| ASecure | Minor issues | |
| BGood | Low severity | |
| CFair | Mixed findings | |
| DWeak | Multiple issues | |
| FFailing | Critical risk | |
| N/ANo scans | Not scanned yet |
Advanced Options
The badge supports standard Shields.io query parameters for full customization. Append these to the badge URL:
| Param | Values | Description |
|---|---|---|
| style | flat, flat-square, plastic, for-the-badge | Visual style of the badge |
| color | brightgreen, green, yellow, orange, red, blue, lightgrey | Override the automatic grade color |
| label | Any URL-encoded string | Custom left-side label (default: "sentinel") |
| logo | shields.io logo name (e.g., github, npm) | Add a logo to the left segment |
Ready to Show Off Your Security Score?
Scan your domain first to generate your badge, then copy the markdown above. Your badge updates automatically after each scan.