DEV Community

Jeannie Nguyen
Jeannie Nguyen

Posted on

How to Add a README to Your GitHub Profile

Alt Text
GitHub just dropped a new feature today.

You can now add a README to your GitHub profile! Think of it like an About Me section for your GitHub.

Here's how it works:

  1. Create a repo with your GitHub username (i.e. https://github.com/jeannienguyen/jeannienguyen)
  2. Create a README.md file inside the repo (you can initialize your repo with a README)
  3. Add content to your README (i.e. intro text, contact links, etc)
  4. Commit and git push your changes

That's it! I've included my profile and would love to see what your GitHub profile looks like--feel free to share the link to your profile below.

Alt Text

Top comments (12)

Collapse
 
waylonwalker profile image
Waylon Walker

Here is what mine looks like so far.

waylonwalker GitHub profile

Collapse
 
unhexeddev profile image
Unhexed.dev

This is amazing!
Definitely deserves to be on the list:

github.com/karansinghgit/Awesome-P...

Collapse
 
waylonwalker profile image
Waylon Walker • Edited

Updated with a list of latest Twitter followers, using GitHub actions.

waylonwalkers GitHub profile

Collapse
 
waylonwalker profile image
Waylon Walker

Made a PR, feel free to modify the format.

Collapse
 
waylonwalker profile image
Waylon Walker • Edited

Updated with a list of latest Twitter followers, using GitHub actions.

waylonwalkers GitHub profile

Collapse
 
vuelancer profile image
Vuelancer
Collapse
 
cmilkaitis profile image
Chris Milkaitis

550 visitors on your page now waylon 👍

Collapse
 
waylonwalker profile image
Waylon Walker

I know I am blown away by that!

I'll probably take it off soon as I am not sure that it has a positive benefit. I don't want others to feel neglected when their count is low.

Collapse
 
lgm527 profile image
Laurell McCaffrey

Love this new feature, thanks for posting Jeannie!
🙂 github.com/lgm527

Collapse
 
jeannienguyen profile image
Jeannie Nguyen

Just saw the README on your GitHub, Laurell - looks good! Thanks for reading!

Collapse
 
waylonwalker profile image
Waylon Walker

Such a cool new feature!

I have a thread of examples running. You should add yours, or just stop by for inspiration.

Collapse
 
unhexeddev profile image
Unhexed.dev

Looks great!
You can add yours here:
github.com/karansinghgit/Awesome-P...