How do I customize my GitHub profile with a README?

[testhub123-sudo]

Select Topic Area

Question

Body

I've seen some GitHub profiles with cool READMEs showing their projects, stats, and even GIFs.
How can I create a custom profile README like that? Is there a specific repo name or format?

[ezhkov-ph]

Hey @testhub123-sudo,

The "secret" is creating a special repository that has the exact same name as your GitHub username.

Here’s a step-by-step guide on how to set it up:

Step 1: Create the Special Repository

1. Click the + icon in the top-right corner of GitHub and select New repository.
2. In the "Repository name" field, type your GitHub username. In your case, it would be testhub123-sudo.
   • As you type, GitHub will show you a special message: ✨ "You found a secret! testhub123-sudo/testhub123-sudo is a special repository that you can use to add a README.md to your GitHub profile."
3. Make sure the repository is set to Public.
4. Important: Check the box that says "Add a README file". This will create the file for you automatically.
5. Click "Create repository".

Step 2: Edit Your README.md File

Now that you have the repository, you can edit the README.md file to add your content. This file uses Markdown for formatting.

Here are some ideas to make it cool, just like the ones you've seen:

About Me & Skills

Start with a brief introduction. You can use badges from Shields.io to show off the technologies you use.

### Hi there, I'm testhub123-sudo! 👋

I'm a passionate developer who loves building cool things.

**I work with:**

![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black)
![Python](https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white)
![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)

GitHub Stats

This is one of the most popular features. You can use the GitHub Readme Stats project by Anurag Hazra. Just copy and paste the Markdown, and replace anuraghazra with your username.

<!-- Replace 'anuraghazra' with your GitHub username -->
[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical)](https://github.com/anuraghazra/github-readme-stats)

[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact&theme=radical)](https://github.com/anuraghazra/github-readme-stats)

GIFs and Images

Adding a GIF is as simple as adding any image in Markdown.

![A cool coding GIF](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExYTJkbzA1a3E0MGw1NjZzdm8zazluZ3o0cThncm04dDVvbmFrcTNjZSZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/L1R1tvI9svkIWwpYqx/giphy.gif)

Step 3: Commit Your Changes

Once you're done editing, scroll to the bottom of the page, add a commit message (like "Create initial profile README"), and click "Commit changes".

Ideas & Inspiration

• Awesome GitHub Profile READMEs: Check out this repository for a huge list of examples and tools.
• Profile README Generators: If you want a quick start, you can use tools like the GitHub Profile README Generator to build a template.

Hope this helps you create an awesome profile! Happy customizing! 🎉