▸ CODESCAN
DocsSupportScanner
README BADGE

README Security Badge

Add a live security grade badge to your repository README. The badge automatically reflects your latest scan score — no manual updates needed.

codescanA 98/100
codescanC 72/100
codescanF 43/100

Getting your badge

  • Go to the Scanner and click the ⬡ Badge button in the header — it copies the Markdown snippet to your clipboard.
  • Paste it into your README.md.
  • The badge updates automatically after every scan saved to your history.

Badge URL format

# SVG badge (use in README img tag)
https://codesscan.com/api/badge/<your-user-id>

# Markdown
![CodeScan](https://codesscan.com/api/badge/<your-user-id>)

# HTML
<img src="https://codesscan.com/api/badge/<your-user-id>" alt="CodeScan grade"/>

How the badge updates

The badge endpoint queries your scan history for the most recent scan and renders the grade and score as an SVG. The badge is cached for 5 minutes by CDN. After every new scan (web or CLI with --save-history), the badge reflects the new result within one cache TTL.

Privacy

The badge endpoint is public and exposes only your latest security grade and score — not the list of vulnerabilities, file names, or any source code. The user ID in the URL is a UUID — not guessable from your name or email.