GitHub Profile README

Complete GitHub profile README examples with cinematic cards. Copy, replace username, done.

A GitHub profile README is the README.md in a repo named after your username. Whatever you put there shows up on your GitHub profile page. These are the cards people actually stop scrolling for.

Full Profile README Example

Copy this. Replace YOURUSERNAME. Paste into your profile README.

<div align="center">

![Profile](https://coolreadme.xyz/api/cinematic?user=YOURUSERNAME&status=SHIPPING+CODE&focus=What+you+build+here&accent=%23A78BFA)

</div>

---

## What I'm Building

![Project](https://coolreadme.xyz/api/netflix-card?title=MY+PROJECT&synopsis=One+sentence+about+what+you+are+building&genre=TypeScript+%C2%B7+React&match=99&quality=PROD)

---

## My Streak

![Streak](https://coolreadme.xyz/api/fox-card?user=YOURUSERNAME)

---

## My Stack

![Stack](https://coolreadme.xyz/api/tech-dna?stack=TypeScript,React,Next.js,Node.js&label=MY+STACK&theme=dark)

Profile Card Examples

Cinematic — the hero card

_{user=yerdaulet-damir} _user=gaearon

Hacker — terminal style

_{user=sindresorhus} _{user=yerdaulet-damir}

Avatar — with your GitHub photo

_{user=karpathy} _{user=addyosmani}

Pet streak — your commit streak as an animal

_{🦊 Fox · evolves with your streak}

_{🐧 Penguin · evolves with your streak}

More Profile README Cards

Card	Use For	Endpoint
Cinematic	Profile hero	`/api/cinematic`
Hacker	Terminal aesthetic	`/api/hacker`
Avatar	Profile with photo	`/api/avatar-card`
Fox / Dog / Cat / Penguin / Owl	Commit streak	`/api/fox-card` etc
Streak	Stats-style streak	`/api/streak-card`
Tech DNA	Stack showcase	`/api/tech-dna`
Netflix	Project showcase	`/api/netflix-card`
Now Listening	Music	`/api/now-listening`
AI Card	AI tool identity	`/api/ai-card`

All cards: no signup, no API key, no rate limits. Just a URL.

→ Browse all 29+ cards and generate yours

Part of the awesome-github-readme collection · Pet Cards · Streak Cards

FilesExpand file tree

GITHUB-PROFILE-README.md

Latest commit

History