How to Write the Perfect GitHub Profile README (with Templates)

Your GitHub profile is more than a repo hub — it’s a space to say “This is who I am.” Done right, your profile README can help you stand out, connect with others, and even land opportunities.

Here’s how to build a clean, effective README — no fluff, just what matters.

1. A Short Intro

Start with a simple greeting and a sentence or two about yourself. Be real, be you.

<h1> Hey <img src="https://emojis.slackmojis.com/emojis/images/1577305505/7373/hand_wave.gif?1577305505" width="50" /> What's up?</h1>

<p> My name is Mauro and I'm a javascript developer, from
<img src="https://cdn-icons-png.flaticon.com/128/197/197386.png" width="17" /> <b>Paraná, Brasil</b>. </p>

2. About Me

Here’s where you show a little personality. What are you learning, working on, or dreaming of?

## About me

- ✨ Creating bugs since 2019
- 📚 I'm currently learning english 🇺🇸 and docker 🐳
- 🎯 Goals: live in a cold place ❄ and speak english 🚀
- 🎲 And ... I play 🎸 guitar and ♟ chess online

3. Tech Stack

Use badges or icons to show the tools you’re comfortable with. It looks clean and helps people get a quick sense of your stack.

## I code with

<a href="https://www.typescriptlang.org" target="_blank">
  <img align="left" title="Typescript" alt="Typescript" width="40px" src="./assets/typescript-logo.svg" />
</a>

<a href="https://pt-br.reactjs.org" target="_blank">
 <img align="left" title="React and React Native" alt="React and React Native" width="40px" src="./assets/react-logo.svg" />
</a>

<a href="https://tailwindcss.com" target="_blank">
 <img align="left" title="Tailwind Css" alt="Tailwind Css" width="40px" src="./assets/tailwind-logo.svg" />
</a>

<a href="https://nextjs.org" target="_blank">
  <img align="left" title="Next Js" alt="Next Js" width="40px" src="./assets/next-logo.svg" />
</a>

<a href="https://nestjs.com" target="_blank">
  <img align="left" title="Nest Js" alt="Nest Js" width="40px" src="./assets/nest-logo.svg" />
</a>

<a href="https://go.dev" target="_blank">
  <img align="left" title="Go Lang" alt="Go Lang" width="40px" src="./assets/golang-logo.svg" />
</a>

<a href="https://graphql.org" target="_blank">
  <img align="left" title="GraphQL" alt="GraphQL" width="40px" src="./assets/graphql-logo.svg" />
</a>

<a href="https://jestjs.io/pt-BR/" target="_blank">
  <img align="left" title="Jest" alt="Jest" width="40px" src="./assets/jest-logo.svg" />
</a>

<a href="https://www.cypress.io" target="_blank">
  <img align="left" title="Cypress" alt="Cypress" width="40px" src="./assets/cypress-logo.svg" />
</a>

<a href="https://storybook.js.org" target="_blank">
  <img align="left" title="Storybook" alt="Storybook" width="40px" src="./assets/storybook-logo.svg" />
</a>

Tip: You can keep icons aligned neatly by using <br clear="left" /> after the last one.

Final Template (Just Paste and Edit)

Here’s how all the parts come together:

# Hey 👋 What's up?

My name is Mauro and I'm a JavaScript developer from Paraná, Brazil.

## About me

- ✨ Creating bugs since 2019
- 📚 I'm currently learning english 🇺🇸 and docker 🐳
- 🎯 Goals: live in a cold place ❄ and speak english 🚀
- 🎲 And ... I play 🎸 guitar and ♟ chess online

## I code with

<!-- Add your favorite icons here just like the example above -->

Want to Generate This Instantly?

Instead of writing it all manually, use the GitHub Profile README Generator — it helps you:

• Pick from multiple templates (including this one)
• Customize sections in real time
• Copy the final version instantly

Give it a try and publish a profile README you're actually proud of — in minutes.

If you want help tweaking your README or trying other layouts, the generator’s got your back.