DEV Community

Cover image for New On GitHub: Add A README Cover To Your GitHub Profile
Suze Shardlow
Suze Shardlow

Posted on • Originally published at suze.dev

New On GitHub: Add A README Cover To Your GitHub Profile

GitHub has recently rolled out a new feature which allows you to add a README to your GitHub profile. Here's how to get yours in two steps.

Originally published at suze.dev.

1) Create a new repo with the same name as your GitHub username.

Go to github.com/new and type your GitHub username into the Repository name field.

Make sure you leave it as a Public repo and initialise it with a README.

When you press the Create repository button, the README will be live immediately with some default content.

Alt Text

2) Customise and edit your README.

You can do this on the GitHub website or clone the repo to your computer and do it locally.

Add whatever text, pictures etc you like. GitHub gives you some suggestions to get started.

Alt Text

If you want to use an image that's in one of your other public repos, link to it in the usual way:

Alt Text

Use the usual markdown formatting for your text.

That's it!

Here's my GitHub profile README!

Discussion (4)

Collapse
waylonwalker profile image
Waylon Walker

Here is what mine looks like so far.

waylonwalker GitHub profile

Collapse
waylonwalker profile image
Waylon Walker

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

Collapse
simonprickett profile image
Simon Prickett 🇪🇺

Thanks - just used your guide to create mine, right now the latest article on my website part is hard coded but I will look at automating it.

github.com/simonprickett

Collapse
waylonwalker profile image
Waylon Walker

I missed their suggestions. I had created a repo with a name matching my username.