Stefan Natter 🇦🇹👨🏻‍💻

Posted on Jul 9, 2020

How to add a README to your GitHub profile

#github #tutorial

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

This is how it works:

Create a repo with your github username (e.g. https://github.com/natterstefan/natterstefan)
Create a README.md file inside the repo
Add content, e.g. a banner, links and an introduction text, and commit the file
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:

Top comments (53)

Lars Christian Schou • Jul 9 '20

Take a look at this.

It amazing. Back to the old days! 🔥

github.com/beyondcode/github-now

Stefan Natter 🇦🇹👨🏻‍💻 • Jul 10 '20

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

Elango Sundar • Jul 15 '20

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.

Waylon Walker • Jul 9 '20

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.

🤓 What's on your GitHub Profile README

Waylon Walker ・ Jul 9 ・ 1 min read

#discuss #github #watercooler

Stefan Natter 🇦🇹👨🏻‍💻 • Jul 10 '20

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

Keff • Jul 9 '20 • 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!

Stefan Natter 🇦🇹👨🏻‍💻 • Jul 9 '20

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

Waylon Walker • Jul 9 '20

Here is what mine looks like so far.

Stefan Natter 🇦🇹👨🏻‍💻 • Jul 11 '20

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.

Andrew Baisden • Jul 10 '20

This is how mine looks at the moment

Stefan Natter 🇦🇹👨🏻‍💻 • Jul 11 '20

I like the banner and the Dragon Ball topic.

Andrew Baisden • Jul 11 '20

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

Thomas H Jones II • Jul 9 '20

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).

Stefan Natter 🇦🇹👨🏻‍💻 • Jul 10 '20

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

Thomas H Jones II • Jul 10 '20

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.

Pol Monroig Company • Jul 9 '20

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

Robert • Jul 10 '20

I can see it without being logged in.

Pol Monroig Company • Jul 10 '20

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

Stefan Natter 🇦🇹👨🏻‍💻 • Jul 9 '20

really? didn’t know that.

Pol Monroig Company • Jul 9 '20

At least yesterday when I tried it😅

𒎏Wii 🏳️‍⚧️ • Jul 10 '20

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

Arturs Smirnovs • Jul 28 '20

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..