explaingit

anuraghazra/github-readme-stats

Analysis updated 2026-06-20

79,282JavaScriptAudience · developerComplexity · 2/5Setup · moderate

TLDR

GitHub Readme Stats generates dynamic cards showing your GitHub activity, stars, commits, top languages, and more, that you embed in any README with a single Markdown line.

Mindmap

mindmap
  root((github-readme-stats))
    Card Types
      GitHub Stats card
      Top Languages card
      Extra Pins
      WakaTime Stats
    Customization
      Themes
      Hide or show stats
      Layout options
    Deployment
      Public hosted instance
      Self-host on Vercel
      GitHub Actions
    Use Cases
      Profile README
      Project README
      Team showcase
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

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

USE CASE 2

Display your top programming languages as a pie chart, donut, or compact list in any project or profile README.

USE CASE 3

Pin specific repositories or Gists to your profile using GitHub Extra Pins cards with live stats.

USE CASE 4

Show your WakaTime coding-time stats on your GitHub profile by connecting the WakaTime Stats card.

What is it built with?

JavaScriptVercelServerless

How does it compare?

anuraghazra/github-readme-statsfortawesome/font-awesometypicode/json-server
Stars79,28276,56375,540
LanguageJavaScriptJavaScriptJavaScript
Setup difficultymoderateeasyeasy
Complexity2/51/51/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 5min

Self-hosting requires a Vercel account and a GitHub Personal Access Token to avoid rate limits on the public instance.

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
Help me deploy my own instance of github-readme-stats on Vercel with a GitHub Personal Access Token so my profile cards never hit rate limits.
Prompt 2
Generate a custom github-readme-stats URL for my profile that shows only commits and stars, uses the dark theme, and hides the rank letter.
Prompt 3
Set up a GitHub Actions workflow that runs github-readme-stats to generate static stat cards into my profile repository automatically each day.
Prompt 4
Write a GitHub profile README that combines a GitHub Stats card, a Top Languages donut chart, and three pinned repo cards using github-readme-stats URLs.

Frequently asked questions

What is github-readme-stats?

GitHub Readme Stats generates dynamic cards showing your GitHub activity, stars, commits, top languages, and more, that you embed in any README with a single Markdown line.

What language is github-readme-stats written in?

Mainly JavaScript. The stack also includes JavaScript, Vercel, Serverless.

How hard is github-readme-stats to set up?

Setup difficulty is rated moderate, with roughly 5min to a first successful run.

Who is github-readme-stats for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Scan in gitsafehub Deploy in gitdeployhub anuraghazra on gitmyhub

Verify against the repo before relying on details.