explaingit

anuraghazra/github-readme-stats

79,454JavaScriptAudience · vibe coderComplexity · 2/5MaintainedLicenseSetup · easy

TLDR

Dynamic GitHub stats cards you embed in README files. Shows commits, stars, languages, and rank, updates live as an image served by a web service.

Mindmap

mindmap
  root((repo))
    What it does
      GitHub stats cards
      Top languages chart
      Repository pins
      WakaTime integration
    How to use
      Copy markdown line
      Set username param
      Deploy on Vercel
      GitHub Actions workflow
    Card types
      Stats card
      Languages card
      Extra pins
      WakaTime card
    Customization
      Theme options
      Layout formats
      Query parameters
      Hide/show stats

Things people build with this

USE CASE 1

Add a live GitHub stats card to your profile README showing commits, stars, and rank.

USE CASE 2

Display top programming languages used across your repos as a pie or donut chart.

USE CASE 3

Pin favorite repositories or Gists in your README and keep them always visible.

USE CASE 4

Show coding time stats from WakaTime directly in your profile or project README.

Tech stack

JavaScriptVercelGitHub APIServerless functions

Getting it running

Difficulty · easy Time to first run · 5min
Use freely for any purpose, including commercial use, as long as you keep the copyright notice and license text.

In plain English

GitHub Readme Stats generates dynamic cards showing your GitHub activity that you can drop into a README file. Instead of static text, the card is an image served by a small web service: it queries GitHub for your account's data and renders an up-to-date summary every time someone views your README. You add it by copying a single Markdown line into your file and changing the username parameter to your own. The project provides several types of cards. The main "GitHub Stats" card shows things like total stars, commits, pull requests, issues, and a rank letter (S, A+, A, A-, B+, B, B-, C+, or C) computed as a weighted percentile across those statistics, inspired by the Japanese academic grading system. There is also a Top Languages card that summarizes the languages used across your repositories with layout options including compact, donut, vertical donut, and pie chart. "GitHub Extra Pins" let you pin specific repositories or Gists by URL, and a WakaTime Stats card surfaces coding-time data when connected to that service. Each card supports query-string parameters to hide or show stats, swap themes, and tune the format. A public hosted instance is available, but the README warns it is best-effort and subject to rate limits, so for reliable cards the recommended approach is to deploy your own instance, either on Vercel using a Personal Access Token, or via a GitHub Actions workflow that generates the cards in your profile repository. Someone would use this to make a profile README more visually informative, or to display project stats inside a project's README. The service is written in JavaScript and runs as a serverless function.

Copy-paste prompts

Prompt 1
How do I add a GitHub stats card to my profile README using github-readme-stats?
Prompt 2
Show me how to customize the GitHub stats card theme and hide certain statistics.
Prompt 3
How do I deploy github-readme-stats on Vercel with my own GitHub Personal Access Token?
Prompt 4
What are the different layout options for the Top Languages card in github-readme-stats?
Prompt 5
How do I use GitHub Actions to generate and update github-readme-stats cards automatically?
Open on GitHub → Explain another repo

Generated 2026-05-18 · Model: sonnet-4-6 · Verify against the repo before relying on details.