DEV Community

How to add a README to your GitHub profile

Alt Text

A new feature arrived on GitHub today. You can finally add a README to your GitHub profile.

This is how it works:

  1. Create a repo with your github username (e.g. https://github.com/natterstefan/natterstefan)
  2. Create a README.md file inside the repo
  3. Add content, e.g. a banner, links and an introduction text, and commit the file
  4. git push your changes.

That's it. 🚀

I'm curious how your GitHub profile looks, share the link to your profile below.

Here is my profile:

Alt Text

Top comments (53)

Collapse
 
negoziator profile image
Lars Christian Schou

Take a look at this.

It amazing. Back to the old days! 🔥

github.com/beyondcode/github-now

Collapse
 
natterstefan profile image
Stefan Natter 🇦🇹👨🏻‍💻

That's cool. I was thinking about something for Spotify too yesterday evening. Funny.

Collapse
 
10secondsofcode profile image
Elango Sundar

I have created a repository for awesome github profile aims to collect the all awesome beautiful READMEs profile and make your Profile look good & Inspire other's.

Collapse
 
waylonwalker profile image
Waylon Walker

I like the clean look of yours. I have a thread of people sharing images of theirs. You can share yours as well or check it out for more inspiration.

Collapse
 
natterstefan profile image
Stefan Natter 🇦🇹👨🏻‍💻

Thanks for sharing the list with me Waylon. After looking at the comments I wanna update mine first XD. People have interesting creative ideas.

Collapse
 
nombrekeff profile image
Keff • Edited

Cool, do you mind if I reference this from my post? I made a post asking people about their opinions on this feature.

Here is my post, if you have any opinions about the feature, please come over and let's talk about it!

Collapse
 
natterstefan profile image
Stefan Natter 🇦🇹👨🏻‍💻

Hi Manolo, thanks it’s fine for me. Go ahead, cool!

Collapse
 
waylonwalker profile image
Waylon Walker

Here is what mine looks like so far.

waylonwalker GitHub profile

Collapse
 
natterstefan profile image
Stefan Natter 🇦🇹👨🏻‍💻

I like the reference to your Digital Garden. That's what I try to achieve here on dev.to (and later on my own site) too.

Collapse
 
andrewbaisden profile image
Andrew Baisden

This is how mine looks at the moment

GitHub

Collapse
 
natterstefan profile image
Stefan Natter 🇦🇹👨🏻‍💻

I like the banner and the Dragon Ball topic.

Collapse
 
andrewbaisden profile image
Andrew Baisden

Thanks I decided to keep it simple but I also wanted to take the opportunity to add some of my design work too.

Collapse
 
ferricoxide profile image
Thomas H Jones II

Nifty. Wonder if they're planning to make it available for orgs (after trying on my personal profile, I attempted similar for an org and it seemed like a "no juice" kind of thing).

Collapse
 
natterstefan profile image
Stefan Natter 🇦🇹👨🏻‍💻

Oh, too bad. Because we were thinking about this for our org too. Thanks for testing it already.

Collapse
 
ferricoxide profile image
Thomas H Jones II

I assume the will add it, because it would likely be even more useful – from a "branding" standpoint – to orgs than individuals. I mean, it's supposedly still in the rollout process – that, even now, not all users have the capability of enabling it.

I submitted a request for our org about it, however. I guess we'll see what their eventual response is.

Collapse
 
polmonroig profile image
Pol Monroig Company

Note that you need to login into an account to be able to see it.

Collapse
 
natterstefan profile image
Stefan Natter 🇦🇹👨🏻‍💻

really? didn’t know that.

Collapse
 
polmonroig profile image
Pol Monroig Company

At least yesterday when I tried it😅

Collapse
 
wobsoriano profile image
Robert

I can see it without being logged in.

Collapse
 
polmonroig profile image
Pol Monroig Company

Ooh, yes me too. They must have updated it. I swear🤞

Collapse
 
singhkshitij profile image
Kshitij Singh

I have tried to collect some Github profile readme examples along with some tips to create one. Please have a look and share feedback.

Here's mine : github.com/singhkshitij

Collapse
 
wjimmycook profile image
Jimmy Cook

Here is my github
github profile

Collapse
 
natterstefan profile image
Stefan Natter 🇦🇹👨🏻‍💻

That's good :D Made me laugh.

Collapse
 
arturssmirnovs profile image
Arturs Smirnovs

Here is a tool that could help you to get started with github readme :)
Add description / social media / badges and other stuff with just few clicks..

GitHub logo arturssmirnovs / github-profile-readme-generator

⭐⭐⭐ Github profile readme generator allows you to create nice and simple github profile readme files that will be included in your profile previews.

Github readme generator

Hi there 👋.

Check out this tool here.

Github readme generator

This project allows you to create nice and simple github profile readme files that will be included in your profile previews.

You can include multiple things: Headers, subtitles, skills, banner, additional information, social media links and statistics badges.

website

Usage

  • Go to: arturssmirnovs.github.io/github-pr...
  • Fill inputs
  • Copy code from textarea
  • Create repository with name that equals your github username
  • Add readme.md
  • Paste copied code and save
  • Enjoy

Preview

Github readme generator

Used

github.com/anuraghazra/github-read...

github.com/arturssmirnovs/github-p...

github.com/simple-icons/simple-icons

Vue JS :)




Collapse
 
darkwiiplayer profile image
𒎏Wii 🏳️‍⚧️

Funny... I've had a DarkWiiPlayer/darkwiiplayer repo for a while now and it seems the difference in capitalization breaks this feature 🤔

Collapse
 
farhati_zakaria profile image
Zakaria Farhati

That's really cool bro, thank you <3

Collapse
 
natterstefan profile image
Stefan Natter 🇦🇹👨🏻‍💻

You're welcome! :D

Collapse
 
ricardobz profile image
Ricardo Beckert

Does anyone know if there is a dev.to badge to use?
Like Twitter, it would be nice...

Collapse
 
anuraghazra profile image
Anurag Hazra

Its super cool. and yesterday i created this ->

hopefully you'll like it :D

Collapse
 
natterstefan profile image
Stefan Natter 🇦🇹👨🏻‍💻

Wow, that's great. I thought of such a feature too. Awesome.