How to build a GitHub profile README that gets noticed

Your GitHub Profile Is a Portfolio Page Too

GitHub shows your profile to anyone who clicks your username from a project, pull request, or search result. Make it work for you.

Creating the Profile README

Create a repository with the exact same name as your GitHub username (e.g., github.com/janedoe/janedoe). The README in this repo appears on your public profile page.

A Minimal, Effective Profile README

# Jane Doe

Frontend engineer building accessible, performant web apps for SaaS teams.

[![Portfolio](https://img.shields.io/badge/Portfolio-janedoe.dev-blue)](https://janedoe.dev)
[![LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-0A66C2)](https://linkedin.com/in/janedoe)

## What I'm Working On
- Building [ProjectName](https://github.com/janedoe/project) — a real-time collaboration tool
- Learning: Rust, WebAssembly

## GitHub Stats
![Jane's GitHub stats](https://github-readme-stats.vercel.app/api?username=janedoe&show_icons=true&hide_border=true)

Keep the profile README short. One-line bio, links to portfolio and LinkedIn, current work, and a stats widget. Profiles with 500 words of text are never read. Pinned repositories below the README are equally important — pin your two strongest projects, not the ones with the most commits.