README Generator

How to Add GitHub Trophies to Your Profile README

GitHub Profile Trophy displays a row of achievement trophies earned based on your GitHub activity metrics. Trophies are awarded for commits, pull requests, issues, stars earned, followers, repositories, and multi-language contributions — each starting at 'secret' rank and leveling up through bronze, silver, gold, platinum, and SSS as your numbers grow. This guide covers the ryo-ma/github-profile-trophy project, which renders as a single image with no setup required beyond including the URL in your README.

Quick Setup Steps

  1. 1

    Step 1: Open your GitHub profile repository and edit README.md.

  2. 2

    Step 2: Add the trophy image: ![Trophies](https://github-profile-trophy.vercel.app/?username=YOUR_USERNAME&theme=tokyonight&no-frame=true&row=1)

  3. 3

    Step 3: Replace YOUR_USERNAME with your GitHub handle.

  4. 4

    Step 4: Add rank=S,SS,SSS,A,AA,AAA to show only earned trophies if you have sufficient GitHub activity.

  5. 5

    Step 5: Commit and push. Visit your profile to verify the trophy row renders correctly.

What Are GitHub Profile Trophies?

GitHub Profile Trophy is a service that awards visual trophies based on quantitative GitHub activity thresholds. Each trophy category has six levels: Secret (hidden until threshold met), Bronze, Silver, Gold, Platinum, and SSS. The levels correspond to increasingly difficult GitHub metrics — for example, the 'Commits' trophy reaches Gold at 500 commits and SSS at 5,000.

The trophy row is a gamification layer that makes your contribution history more visually engaging. It works best for developers with meaningful GitHub activity — if your account is new or lightly used, some trophies will show at Secret rank, which may look sparse. The rank filter parameter lets you show only trophies you have actually earned above a certain level.

How to Add GitHub Trophies

Adding trophies requires one line of markdown:

![Trophies](https://github-profile-trophy.vercel.app/?username=YOUR_USERNAME&theme=tokyonight&no-frame=true&row=1)

To show only your highest-ranked trophies:

![Trophies](https://github-profile-trophy.vercel.app/?username=YOUR_USERNAME&rank=S,SS,SSS,A,AA,AAA&theme=tokyonight&no-frame=true&row=1)

For a centered display with 6 trophies per row:

<div align="center">
  <img src="https://github-profile-trophy.vercel.app/?username=YOUR_USERNAME&theme=tokyonight&no-frame=true&row=1&column=6" />
</div>

Replace YOUR_USERNAME with your GitHub username. The service fetches your data from GitHub's API in real time — no authentication, no Action, no setup.

Customizing GitHub Trophies

Key customization parameters:

  • theme: Available themes include tokyonight, darkhub, onedark, gruvbox, radical, flat, algolia, gitdimmed, transparent, nord, juicyfresh
  • rank: Filter by rank level — SECRET, SSS, SS, S, AAA, AA, A, B, C (comma-separated to show multiple)
  • no-frame=true: Removes the border around each trophy
  • no-bg=true: Removes the background (use with transparent theme for borderless cards)
  • row: Number of rows (default 1, max 3)
  • column: Number of columns per row (default 6, max 6)
  • margin-w and margin-h: Pixel margin between trophies

Hiding specific trophies: add &hidden=reviews,experience where experience corresponds to the 'Experience' trophy category.

Troubleshooting GitHub Trophies

If the trophy card shows a 'No data available' error, check that your GitHub username is spelled correctly and your profile is public. The service reads your public GitHub data — private repository contributions are not included in trophy calculations.

If the card renders but all trophies show as 'Secret', it means you haven't met the minimum threshold for any visible trophy rank. This is common for newer accounts. Use &rank=SECRET to confirm the widget is working correctly, then build up activity to reveal trophies.

If the image is not rendering in your README, confirm you are using the correct base URL: github-profile-trophy.vercel.app (not github-profile-trophies). The vercel.app domain is rate-limited on the free tier — if loading frequently fails, deploy your own instance.

Frequently Asked Questions

How do I add GitHub trophies to my README?

Add this to your README: `![Trophies](https://github-profile-trophy.vercel.app/?username=YOUR_USERNAME&theme=tokyonight&no-frame=true&row=1)`. To show only earned trophies (not secret ones), add &rank=S,SS,SSS,A,AA,AAA to filter out lower-ranked or unearned trophies.

Is the GitHub Profile Trophy widget free?

Yes. The ryo-ma/github-profile-trophy project is open source under MIT license. The public Vercel endpoint is free to use with no API key or account required. You can also fork and self-host the project on Vercel for guaranteed uptime and unlimited requests.

Why are all my GitHub trophies showing as Secret?

Secret trophies appear when you haven't reached the minimum threshold for a visible rank. Common thresholds: Commits Bronze (10 commits), Stars Bronze (1 star received), PRs Bronze (1 PR merged). Build up your GitHub activity and trophies will become visible. Use the rank filter to show only non-secret trophies.

Can I choose which trophies to display?

Yes. Use the rank parameter to filter by rank level (e.g., rank=S,SS,SSS to show only top-tier trophies). Use the hidden parameter to exclude specific trophy categories you don't want to show (e.g., hidden=experience,reviews). The column parameter controls how many trophies appear per row.

From Our Blog

Generate Your GitHub Profile README

Generate a GitHub profile README featuring GitHub Trophies with AI

Try It Free — No Sign Up