DEV Community

How to add a README to your GitHub profile

Stefan Natter πŸ‡¦πŸ‡ΉπŸ‘¨πŸ»β€πŸ’» on July 09, 2020

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 gith...
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
Β 
polcompany profile image
Pol Monroig Company β€’

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

Collapse
Β 
wobsoriano profile image
Robert β€’

I can see it without being logged in.

Collapse
Β 
polcompany profile image
Pol Monroig Company β€’

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

Collapse
Β 
natterstefan profile image
Stefan Natter πŸ‡¦πŸ‡ΉπŸ‘¨πŸ»β€πŸ’» β€’

really? didn’t know that.

Collapse
Β 
polcompany profile image
Pol Monroig Company β€’

At least yesterday when I tried itπŸ˜…

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
Β 
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
Β 
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
Β 
brianxfury profile image
εΈƒθŽ±ζ© θΏͺ马巴耀 β€’

That's awesome! Thank you for the tip!

Collapse
Β 
andypiper profile image
Andy Piper β€’

I kept it simple -> github.com/andypiper

Collapse
Β 
natterstefan profile image
Stefan Natter πŸ‡¦πŸ‡ΉπŸ‘¨πŸ»β€πŸ’» β€’

I like yours!

Collapse
Β 
thinkverse profile image
Kim Hallberg β€’

Ooh wow, didn’t know about this one, cool, thanks for the tip, I’m going to be sharing this one. πŸ˜€

Collapse
Β 
natterstefan profile image
Stefan Natter πŸ‡¦πŸ‡ΉπŸ‘¨πŸ»β€πŸ’» β€’

Thanks, Kim and you're welcome.

Collapse
Β 
sethusenthil profile image
Sethu Senthil β€’ β€’ Edited

Does your repo have to be public for this? I mean, it does not really matter just wondering!

EDIT: It does!

Collapse
Β 
natterstefan profile image
Stefan Natter πŸ‡¦πŸ‡ΉπŸ‘¨πŸ»β€πŸ’» β€’

Thanks for testing this.

Collapse
Β 
lachlanv profile image
lachlanv β€’

What an awesome, fun tip.

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.

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
Β 
hevalhazalkurt profile image
Heval Hazal Kurt β€’

Here is mine

Collapse
Β 
oop profile image
I'm β€’ β€’ Edited

Interesting feature! Mine is also ready. :)

Collapse
Β 
hassanabral profile image
Hassan Abral β€’

Here is mine: github.com/hassanyakef

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
Β 
francotel profile image
francotel β€’ β€’ Edited

Great, my profile:

Collapse
Β 
5456qwe profile image
1214586 β€’

thanks bro

Collapse
Β 
sauravgupta2800 profile image
Saurav Gupta β€’

test out my profile: github.com/sauravgupta2800

Collapse
Β 
bharatdwarkani profile image
Bharat Dwarkani β€’

Here is mine - github.com/bharatdwarkani

Profile Image

Collapse
Β 
groverception profile image
Anuj Grover πŸ‘¨πŸ»β€πŸ’» β€’

github.com/groverception

keeping it simple for now :)

Collapse
Β 
hibritusta profile image
Hibrit Usta β€’

Thank you

Collapse
Β 
natterstefan profile image
Stefan Natter πŸ‡¦πŸ‡ΉπŸ‘¨πŸ»β€πŸ’» β€’

You're welcome.

Collapse
Β 
ajnasz profile image
Lajos Koszti β€’

Seriosly?

Collapse
Β 
natterstefan profile image
Stefan Natter πŸ‡¦πŸ‡ΉπŸ‘¨πŸ»β€πŸ’» β€’

Yes! :)

Collapse
Β 
chetangawai profile image
Chetan Gawai β€’

Keeping it simple for now. Here is my profile -
github.com/chetangawai

Collapse
Β 
iamother profile image
Andres RomaΓ±a β€’

Thank you, salute from colombia.

Collapse
Β 
elvinaqa profile image
Elvin Aghammadzada β€’ β€’ Edited

Check it out