Generate a professional GitHub profile README in seconds — just enter a username.
Click above to open the app — enter any GitHub username and get a full profile README instantly.
- Open the app: Try It Live
- Type your GitHub username in the input field
- Click Generate README (or press Enter)
- The app will fetch your profile, repos, languages, and stars automatically
- Scroll down to see the generated README preview
You have two options:
- Copy — Click the Copy button to copy the raw markdown to your clipboard
- Download — Click the Download README.md button to save it as a file
GitHub shows a special README on your profile page. To set it up:
- Go to github.com/new to create a new repository
- Set the Repository name to exactly your GitHub username
- Example: if your username is
johndoe, name the repojohndoe
- Example: if your username is
- Make sure it is set to Public
- Check the box "Add a README file"
- Click Create repository
GitHub will show a message: "johndoe/johndoe is a special repository — its README.md will appear on your profile!"
- Open the repository you just created (
github.com/YOUR_USERNAME/YOUR_USERNAME) - Click the pencil icon (Edit) on the
README.mdfile - Select all the existing content and delete it
- Paste the markdown you copied from the generator (Ctrl+V / Cmd+V)
- Click Commit changes
- Add a commit message like "Add profile README" and click Commit changes
- Go to github.com/YOUR_USERNAME
- Your new profile README is now live!
- You should see your bio, stats, tech stack, top projects, trophies, and more
Just come back to the generator, enter your username again, and repeat Steps 2 and 4. Your stats, repos, and trophies will be refreshed with the latest data.
| Section | Description |
|---|---|
| Header | Animated wave, your name, and bio |
| Social Badges | Followers count, profile views |
| About Me | Repos, stars, location, company, blog link |
| Tech Stack | Language and framework badges auto-detected from your repos |
| Top Projects | Table of your best repos with stars and language |
| GitHub Stats | Total stars, repos, followers, and forks (shields.io badges) |
| Top Languages | Percentage breakdown with color-coded badges |
| Streak Stats | Current streak, longest streak, total contributions |
| Trophies | Achievement badges based on your actual stats (stars, repos, followers, languages, forks, account age) |
| Connect | Links to your GitHub, Twitter, website, and email |
Everything is generated from your real GitHub data — no fake numbers, no manual editing needed.
Enter username torvalds and you get a complete profile README with:
- Stats badges showing 228K+ stars, 8 repos, 284K+ followers
- Language badges for C, Shell, etc.
- Trophy badges like Star Legend, GitHub Celebrity, GitHub Pioneer
- Top projects table with linux, subsurface, etc.
- And more — all auto-generated
- No login required — uses GitHub public API only
- No dependencies — runs entirely in the browser
- Dark theme with GitHub-inspired design
- Responsive — works on mobile, tablet, and desktop
- Live preview — see the rendered README before copying
- One-click copy or download the README.md file
- Smart detection — infers frameworks (React, Docker, AWS, etc.) from your repo names and topics
- Native stats — uses shields.io badges that always load (no broken images)
- Achievement trophies — tiered badges based on your real GitHub milestones
- Rate limit friendly — only 2 API calls per generation
The GitHub public API allows 60 requests/hour without authentication. Each generation uses 2 requests (user + repos). If you hit the limit, wait a few minutes.
If you forked this repo and want to host your own version:
- Go to your repo on GitHub
- If the code is on a feature branch, merge it to
mainfirst - Go to Settings > Pages
- Under Source, select Deploy from a branch
- Pick
mainbranch,/ (root)folder, click Save - Wait ~2 minutes — your site is live
MIT License. Free to use, modify, and distribute.