loading...

How to add a README to your GitHub profile

natterstefan profile image Stefan Natter πŸ‡¦πŸ‡ΉπŸ‘¨πŸ»β€πŸ’» ・1 min read

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

Discussion

markdown guide
 

Take a look at this.

It amazing. Back to the old days! πŸ”₯

github.com/beyondcode/github-now

 

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

 

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.

 

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.

 

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

 

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!

 

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

 

Here is what mine looks like so far.

waylonwalker GitHub profile

 

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.

 

This is how mine looks at the moment

GitHub

 
 

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

 

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

 

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

 

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.

 

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

 
 

I can see it without being logged in.

 

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

 

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




 

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

 

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

 
 

Its super cool. and yesterday i created this ->

hopefully you'll like it :D

 

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

 

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

 
 

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

EDIT: It does!

 
 
 

Interesting feature! Mine is also ready. :)

 
 
 

That's awesome! Thank you for the tip!

 
 
 
 

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

 
 
 
 
 

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