Follow every phase in order. Do not skip steps. By the end, your profile will be outstanding.
- Phase 1 — Create Your Profile Repository
- Phase 2 — Write Your About Me
- Phase 3 — Add Your Tech Stack
- Phase 4 — Add GitHub Stats
- Phase 5 — Pin Your Best Repositories
- Phase 6 — Make It Dynamic
- Phase 7 — Final Checklist
This is the foundation. GitHub has a secret feature — if you create a repository with the exact same name as your username, it becomes your profile README.
- Go to github.com/new
- In Repository name, type your exact GitHub username
- Example: if your username is
john-doe, the repo name must bejohn-doe
- Example: if your username is
- Make sure it is set to Public
- Check ✅ Add a README file
- Click Create repository
💡 You will see a special message from GitHub: "✨ john-doe/john-doe is a special repository..." — that means it worked!
- Click on the
README.mdfile in your new repo - Click the pencil icon ✏️ to edit it
- Delete all the default content — you will replace it completely
Your README.md is just a Markdown file. Think of it like a web page made of text. You will use:
#for headings**text**for bold[text](url)for linksfor images- HTML tags like
<div align="center">for alignment
This is the most personal part. It tells visitors who you are in seconds.
Copy this and customize it:
<div align="center">
# Hi there, I'm [Your Name] 👋
### [Your Title — e.g., Full Stack Developer | Open Source Enthusiast]
</div><div align="center">
[](https://git.io/typing-svg)
</div>✏️ Change the
lines=part to match your own description. Separate lines with;
## 🙋 About Me
- 🔭 I'm currently working on **[Your Current Project]**
- 🌱 I'm currently learning **[What You're Learning]**
- 👯 I'm looking to collaborate on **[Type of Projects]**
- 💬 Ask me about **[Your Expertise]**
- 📫 How to reach me: **[your@email.com]**
- ⚡ Fun fact: **[Something Interesting About You]**💡 Tips for a great About section:
- Be specific. "Learning React and Node.js" is better than "Learning web development"
- Keep it to 5-7 bullet points maximum
- Make it feel human, not like a resume
<div align="center">
[](YOUR_LINKEDIN_URL)
[](YOUR_TWITTER_URL)
[](YOUR_PORTFOLIO_URL)
[](mailto:YOUR_EMAIL)
</div>✏️ Replace
YOUR_LINKEDIN_URL, etc. with your real links. Remove any you don't use.
📄 Read more: sections/about-me.md
This shows visitors what technologies you know — at a glance.
## 🛠️ Tech Stack
### Languages
### Frameworks & Libraries
### Databases
### Tools
💡 Rules for Tech Stack:
- Only add technologies you actually know — keep it honest
- Group them logically (Languages → Frameworks → Tools)
- Do not add too many — 10-15 badges is ideal
📄 Full badge list: sections/skills-badges.md
These are live widgets that automatically update with your real GitHub data.
## 📊 GitHub Stats
<div align="center">
</div><div align="center">
</div><div align="center">
</div><div align="center">
<img src="https://github-readme-stats.vercel.app/api?username=YOUR_USERNAME&show_icons=true&theme=tokyonight&hide_border=true" height="165" />
<img src="https://github-readme-stats.vercel.app/api/top-langs/?username=YOUR_USERNAME&layout=compact&theme=tokyonight&hide_border=true" height="165" />
</div>✏️ Replace
YOUR_USERNAMEwith your actual GitHub username everywhere 💡 Try different themes:tokyonight,radical,merko,gruvbox,dracula,nord
📄 All stats options: sections/stats.md
Pinned repos are the showcase of your work. This is what visitors look at after your README.
- Go to your GitHub profile page
- Click "Customize your pins" (below your bio)
- Select up to 6 repositories to pin
- Click Save pins
Follow this priority order:
- ✅ Projects with a good README (visitors will click through)
- ✅ Projects that show your best technical skills
- ✅ Projects that are complete, not abandoned
- ✅ Projects with some stars or forks (social proof)
- ✅ Projects that are diverse (don't pin 6 similar things)
Each pinned repo needs at minimum:
- A clear title and description
- What the project does (1-2 sentences)
- How to install/run it
- A screenshot or demo GIF if possible
- Tech stack used
📄 Full guide: sections/projects.md
Take your profile from static to alive with auto-updating content.
<div align="center">
</div>## 📈 Activity Graph
Create .github/workflows/update-readme.yml in your profile repo:
name: Update README
on:
schedule:
- cron: '0 0 * * *' # Runs every day at midnight
workflow_dispatch:
jobs:
update:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Update README
run: echo "Add your update script here"💡 You can use this to auto-pull your latest blog posts, tweets, or GitHub activity into your README every day automatically.
Before you call your profile done, go through every item:
- Profile photo is clear and professional
- Real name is set (or preferred name)
- Bio is filled (keep it under 160 characters)
- Location is set
- Website/portfolio link is added
- Email is set to public (if comfortable)
- Has a clear, welcoming header
- Has an About Me section with specific details
- Has social/contact links
- Has tech stack badges (only real skills)
- Has GitHub stats widgets
- Has streak counter
- Looks good on both desktop and mobile
- Up to 6 repos are pinned
- Every pinned repo has a description set
- Every pinned repo has a proper README
- Repos are tagged with relevant topics
- No spelling mistakes (proofread everything)
- All links work (test every one)
- Contribution graph shows recent activity
- Profile is set to Public
You have built an outstanding GitHub profile. Now:
- Star this repo ⭐ if it helped you
- Share your result in examples/README.md
- Keep your profile updated — add new skills, new projects, new achievements
💡 The best profiles are never "done" — they grow with you.