README Badge

Add a badge to your GitHub README that shows when your changelog was last updated. Clicking the badge takes visitors to your hosted changelog page.

Markdown

[![ShipRelay](https://shiprelay.io/api/badge/YOUR_SLUG)](https://shiprelay.io/YOUR_SLUG)

HTML

<a href="https://shiprelay.io/YOUR_SLUG">
  <img src="https://shiprelay.io/api/badge/YOUR_SLUG" alt="ShipRelay changelog" />
</a>

Replace YOUR_SLUG with your project slug.

What it shows

A shield-style SVG badge displaying "changelog | updated X days ago" — similar to shields.io badges.

Caching

The badge is cached and updates periodically. There may be a short delay after publishing a new changelog before the badge reflects the update.

Rate limiting

The badge endpoint is rate-limited to prevent abuse (60 requests per IP per minute). This is more than sufficient for README rendering.