DEV Community

Cover image for Create the best GitHub Readme ever! ๐Ÿš€
Susnata Goswami
Susnata Goswami

Posted on

Create the best GitHub Readme ever! ๐Ÿš€

Customize your Readme to attract more viewers and stand out from the rest.

Use the following and change the URL/terms with respect to your account.

Checkout My Readme

โ–ถ Displaying our header picture


Either you can use Reheader to generate a header for you, or you can use Photoshop to create your own. You can even ping me if you want me to do it for you!


โ–ถ Portfolio Badge


Website


โ–ถ About Yourself


Example:

Currently, I am a web development intern at Promenant Innovation Labs

  • ๐Ÿ”ญ Iโ€™m currently working on React.JS
  • ๐Ÿš€ Iโ€™m looking to collaborate with other developers
  • ๐Ÿฅ… 2020 Goals: Expertise in web development, contribute to Open Source projects, and survive this pandemic!
  • โšกFacts about me: I listen to alternative and progressive rock; I like to draw and doodle anime and binge-watch movies, series, and read comics!

    โ–ถ Your Resume

  • Adding a gif is more attractive, but you can even add a text with a link. Example:

โ–ถ Adding your Skill Set

  • You can find SVG/PNG/GIF files online. You can also add a technology/stack logo by simply searching it on GitHub and opening the image in a new tab.

    See This Example.

    Here, you can replace "javascript" with "html" and you'll get the logo for HTML.


โ–ถ Adding GitHub Stats

โ€ขVisit this repository
Follow the instructions, and add the stats!


โ–ถ Adding your Spotify Updates

โ€ขVisit this repository
Follow the instructions, and add your dynamically generated Spotify Updates!


โ–ถ Adding social media icons

Example:

Connect with me:


twitter


linkedin


facebook


codepen


instagram

Top comments (3)

Collapse
 
lukeswitz profile image
Luke Switzer

Curious what people think of the readme as a portfolio. From personal experience, I enjoyed GitHub far more before all this self-branding: Pin your best work, the end.

Your contributions are there to see without adding half the MySpace UI elements. The auto-stats & badges have been confusing to those unfamiliar with the site, and a pissing contest for a lot of new devs.

Microsoft owns LinkedIn and GitHub. Ideally theyโ€™d replace the used car dealership experience of LinkedIn with actively updated information, not curated by individual developers but by stats alone. I have work and personal accounts, some repos & accounts simply shouldnโ€™t be analyzed by third parties for privacy & security reasons. //end rant

Collapse
 
proghead00 profile image
Susnata Goswami • Edited

Opinions differ. A cool Readme with dynamic features feels great. Also, it's fun to customise.

Collapse
 
lukeswitz profile image
Luke Switzer

Absolutely! Plain is boring