DEV Community

Ismael López
Ismael López

Posted on

4 2

Add a README.md to your GitHub profile.

Are you want to add a short description to your GitHub profile? Are you know this feature? Here I explain you how to do it. I learned this feature when I was scrolling on Twitter and this is the result.

I show you how to implement it step by step, I hope that this will be useful for you.

Create a repository

This is a secret feature, you do not tell anyone :)

First step, create a GitHub repository with the same name of your username.
Alt Text

Import or create a local repository

When you create a repository you can do one of this options.

Create a local repository, we will do this.
Alt Text

Or import a local repository, I know it, only is a file.
Alt Text

Create a mardown file

You must create a Markdown file named README.md with content like this.

Alt Text

Final result

Here you can see the final result.

Hi, I'm Ismael López

Web Developer and Computer Systems Engineer

Twitter: ismaellopezdev GitHub Ismael

view raw README.md hosted with ❤ by GitHub

Thanks, for more content you can follow me on my social media. See you.

Sentry image

Hands-on debugging session: instrument, monitor, and fix

Join Lazar for a hands-on session where you’ll build it, break it, debug it, and fix it. You’ll set up Sentry, track errors, use Session Replay and Tracing, and leverage some good ol’ AI to find and fix issues fast.

RSVP here →

Top comments (0)

A Workflow Copilot. Tailored to You.

Pieces.app image

Our desktop app, with its intelligent copilot, streamlines coding by generating snippets, extracting code from screenshots, and accelerating problem-solving.

Read the docs

👋 Kindness is contagious

Please leave a ❤️ or a friendly comment on this post if you found it helpful!

Okay