Quick Guide

What to Enter

User: Your GitHub username (e.g., octocat)
Repo: Repository name (e.g., hello-world)

Badge Types

Contributors: People who have contributed code to the repository
Sponsors: Users or organizations financially supporting the author
Stargazers: Users who starred the repository
Watchers: Users subscribed to repository updates
Forkers: Users who forked the repository
Followers: Users following this GitHub account

Advanced Options

Dynamic: Load avatars directly from URLs (faster, for iframe use)
Format: Output as SVG (default) or PNG image

Parameters

Code Snippet

Preview

Building your badge

Static Dynamic

Examples

Want to get an idea of what readme-contribs can do? Generate some examples!

Loading example

Self-Hosting

You can use our managed instance here for free, forever. But if you plan to use at any scale, it's highly recommended to deploy your own version of readme-contribs for ultimate control, flexibility and uptime. Don't worry, it's quick, free and easy :)

Option 1: Deploy to Vercel

1-Click Deploy

Or, fork our repo, then login to Vercel and import it.

Tip: Set the Environment Variable GITHUB_TOKEN in Vercel to avoid rate limits! Generate this in your GitHub Developer Settings.

Option 2: Deploy with Docker

docker run -d \
  -p 8080:8080 \
  -e GITHUB_TOKEN=your_token \
  ghcr.io/lissy93/readme-contribs:latest

Or use our docker-compose.yml as a template

Badge Generator