DEV Community

loading...
Cover image for Make Your GitHub Profile Great Again!

Make Your GitHub Profile Great Again!

pedes profile image Andres Cespedes Morales ใƒป3 min read

Last Month (July 2020) GitHub released a feature to allow users to create profile-level README to display an interesting view of their profiles.

You may want to add personal information about yourself in your bio, like previous projects you've contributed to, or interests you have that other person may like to know about.

If you want to get access to the README template go to my profile -> here

๐Ÿค“ How to Create a GitHub Profile's README?

You have to add a README file to the root of a public repository with the same name as your username, then that README will automatically appear on your profile page.

You will see a nice banner indicating that you have found a secret on GitHub

GitHub Profile README

Is that it? Yes, as simple as that you will have now a landing README for your profile.

Note: The naming convention is case-sensitive, so make sure the names of your repo and profile match.

๐Ÿ’ป What am I going to get?

As soon as you create your repo, a README file with the following template will be created:

**pedes/pedes** is a โœจ _special_ โœจ repository because of its README.md (this file) appears on your GitHub profile.`

Here are some ideas to get you started:

- ๐Ÿ”ญ Iโ€™m currently working on ...`
- ๐ŸŒฑ Iโ€™m currently learning ...
- ๐Ÿ‘ฏ Iโ€™m looking to collaborate on ...
- ๐Ÿค” Iโ€™m looking for help with ...
- ๐Ÿ’ฌ Ask me about ...
- ๐Ÿ“ซ How to reach me: ...
- ๐Ÿ˜„ Pronouns: ...
- โšก Fun fact: ...

Github Profile Template
GitHub Profile README Example

๐ŸŒž How to make it shine?

Here comes the most exciting and fun side of this. Markdown supports different elements, like emojis, GIFs, images, tables, etc, that allows you to come up with an astonishing design.

I've collected a list of resources that will help you and guide you through the process of crafting an exceptional GitHub profile.

Click on the titles to access to the resources.

Markdown Cheat Sheet Sample

Get to know the fundamentals of Markdown, and how to leverage its features on your README.

Simple Icons Sample

Include icons from the most "iconic" software projects and tools used in your day-to-day job.

GitHub README Profile Creator Sample

Easy and simple way to create your profile README with an open-source tool.

Alt Text

profile-views-counter-banner

GitHub README Profile Generator GIF

GitHub Readme Stats Sample

Shields.io Home Page

๐Ÿ’ซ Looking for some inspiration?

Here is a quick dose of inspiration for creating your own profile:

๐Ÿƒ Where to go from here?

Perhaps, do you want to share your ideas and craft with the world?

Post your profile in the comments below, bookmark this post or share it with your friends to find and see what they can come up with.

Thanks for reading. โœŒ๏ธ

Discussion

pic
Editor guide
Collapse
delta456 profile image
Collapse
pedes profile image
Andres Cespedes Morales Author

Your profile is very dope Swastik. Do you mind if I borrow some icons and badges from yours?

Collapse
delta456 profile image
Swastik Baranwal

Sure you can use it. Its a template after all

Collapse
jankapunkt profile image
Jan Kรผster

Great summary, I immediately started to create my own profile.

However, a weird question arises - What license would be appropriate, since it asks me for a license and usually it is very clear to me which license to chose but I started pondering about this one... does it even make sense to add a choose license option here?

Collapse
pedes profile image
Andres Cespedes Morales Author

Great question Jan.

Indeed, it's a bit odd to have a software license for something that's only content. But it's fair to say that this repo could be considered documentation, therefore a license is suitable here: choosealicense.com/

So, better to have a public license than no license at all.

Collapse
canro91 profile image
Collapse
pedes profile image
Andres Cespedes Morales Author

Great, minimalistic and professional.

Collapse
canro91 profile image
Cesar Aguirre

Thanks Andres

Collapse
karthiknayak profile image
Collapse
pedes profile image
Andres Cespedes Morales Author

Another one for good inspiration. Awesome Karthik.

Collapse
karthiknayak profile image
Karthik-Nayak

Thanks Andres

Collapse
codeperfectplus profile image
CodePerfectPlus

Here is Mine...

Hi ๐Ÿ‘‹, I'm Codeperfectplus

Licence Visitors Last Commit

Coding

ย  ย  About Me

Skilled in Data Science, Machine Learning, Deep Learning, As Well As Basic Basic Web Development Knowledge. Strong professional with a Master's Diploma in Data Science.

ย  ย  ย  ย  Keep Learning ๐Ÿ‘จโ€๐ŸŽ“๏ธ๏ธ


๐Ÿ“ˆ Github Stats:








๐Ÿ› ๏ธ Languages & Tools:

HTML CSS Javascript ReactJs Python Django C++

VSCode Git Linux

codeperfectplus codeperfectplus codeperfectplus codeperfectplus






Collapse
pedes profile image
Andres Cespedes Morales Author

Great to highlight your website hosted in Heroku, are you having a paid plan ? I guess so.

How did you create that personal GIF? Pretty dope.

Collapse
codeperfectplus profile image
CodePerfectPlus

I just borrowed this gif and changed my whole Github readme profile.
Credits to KarthikNayak024

I am using the free plan of Heroku and soon going to migrate to AWS or any other better options.

Collapse
hemant profile image
Hemant Joshi ๐Ÿ˜ผ

Have a look at mine.
๐Ÿ™„๐Ÿ‘‰๐Ÿ‘ˆ

GitHub logo 8bithemant / 8bithemant

Awesome Github ReadME, Dynamic nature Built with Love. Please consider to follow and star, Contribution are accepted, Free Fell To Fork

Hi there, I'm Hemant! ๐Ÿ‘‹.

Full Stack | System Design | Micro Services | Competetive Programming | Machine Learning

Twitter Follow


GIF

I'm 18 years old Self-taught Full-Stack developer from India.

  • ๐Ÿฅ€ Learning GraphQl ,NextJs &Typescript .

  • ๐Ÿ”ญ SpaceX FanBoi,

    • Vanilla Js in Space๐Ÿ˜ผ
  • ๐Ÿ›ธ Into High Energy Physics and Astrophysics

  • ๐Ÿ’ฌ Connect? Here ๐Ÿ‘‰๐Ÿผ

- Languages and Tools...

html csharp js python react vue chrome cloud datascience aws npm gcp bash vscode

- Blogs ๐ŸŒฑ

- Podcast โšก๏ธ


Thank You-๐Ÿ™๐Ÿผ








Here is mineโ˜บ๏ธ
Collapse
pedes profile image
Andres Cespedes Morales Author

Hi Hemant, liked the badges that you included. I will borrow some of them for my profile if you don't mind.

Collapse
hemant profile image
Hemant Joshi ๐Ÿ˜ผ

Yup, I have too borrwoed them.

Check out the About.md and there you find the origin of Badges and get a tom of Custom bates.

Collapse
thomasbnt profile image
Thomas Bnt

Nice, see my GitHub profile for more social icons ๐Ÿ™Œ๐Ÿผ

Collapse
pedes profile image
Collapse
thomasbnt profile image
Thomas Bnt

Thank you friend ๐Ÿ˜‰

Collapse
mindset profile image
Jayesh Tembhekar โšก

Great post.
Thank you Andres ๐Ÿ•บ

Collapse
pedes profile image
Andres Cespedes Morales Author

Glad you liked it Jayesh :)

Collapse
juanfrank77 profile image
Juan F Gonzalez

Great post Andres. The Github profiles for inspiration are quite nice, I've only seen the first one before.

I updated mine some days ago.

Collapse
pedes profile image
Andres Cespedes Morales Author

Good stuff Juan, looking forward to seeing some additions to your profile.

Collapse
hiteshpatel1142 profile image
HiteshDhamshaniya

Thank you for writing this useful article about GitHub profile.

Collapse
pedes profile image
Andres Cespedes Morales Author

Nice starting point for all of us. Thanks.

Collapse
arturssmirnovs profile image
Arturs Smirnovs

Thanks for including my generator :)

Collapse
pedes profile image
Andres Cespedes Morales Author

It's a nice tool, how to miss it? :)

Collapse
raychy profile image
Adeyemi Racheal Oyindamola

Thanks for sharing, gonna try it out

Collapse
pedes profile image
Andres Cespedes Morales Author

There are very good ideas on people's comments.

Collapse
saberglow profile image
Wali Ullah

here's the fruit of my efforts: @SABERGLOW

Collapse
pedes profile image
Andres Cespedes Morales Author

Thanks for sharing Wali.

Collapse
jamesharrys profile image
James Harrys

Here's mine, I'm pretty proud of it :) github.com/JamesHarrys

Collapse
pedes profile image
Andres Cespedes Morales Author

Dope, do you create that type of sketch/design? Would love to get one too.

Collapse
ramblingenzyme profile image
Satvik Sharma

Could we not with the "Make X Great Again"?

Collapse
viniciuscovre profile image
Vinicius Covre

Great post! Take a look at mine: github.com/vinacovre