How to Create Github README as Resume?

Explore new ways of showing your GitHub resume as a developer or opensource contributor

Pratik Kumar
Jul 15, 2020 · 4 min read
Photo by Ash Edmonds on Unsplash

Create a README markdown file that is your new opensource resume/CV !

GitHub introduced a new feature within a developer’s repository. It’s a secret. The user can now put on their details in a special repository within a README file.

https://github.com/pr2tik1/pr2tik1 (Updating regularly with new features, so it might not be the same in future)

I went for a minimalistic design, Hope you like it! 😋

So why not use all possible ways to make your profile look cool? This gives chance to recruiters to see more about your open-source contributions. Make this your new resume!!

What are the STEPS to follow?

Let's create your first awesome README!

Special Repo!
  1. Create a repository with your GitHub name.
  2. Add readme file to it, README.md
  3. You may notice GitHub introduces you with some format, you can edit that too.
  4. If you want a banner then you may follow, Canva and edit the banner images there,
    - Click here.
    - You can edit banners such as,
Click here to get this design

5. To add your social network badges in README.md file view the following collection,

6. You can also add an awesome Github stats card, that shows your current stats dynamically,

Stats-Card

Get your GitHub-readme-stats below, made by Anurag Hazra,

Additional awesome resources :

Must try these awesome tools!

Github Profile README generator by Rahul Jain,

Github Activity README by James George,

Waka Readme Stats by Anmol,

A view of my profile’s Waka-stats

Add visitors badges from (git-badges),

Blog Cards-

GitHub Quotes by Shravan

Finally, you can view simple markdown code below for reference,

Change the name README.txt to README.md

The above code snippet can be used with the following changes,

  • Change the name of the file to README.md
  • Change the image directory and name from ‘IMAGE-NAME’ to one you will upload.
  • Change all the descriptions to yours, like what you are currently working on.
  • Change all the username area, which is highlighted by ‘USERNAME’.

You can also look for some cool repositories and other people’s work here and below,

The Startup

Get smarter at building your thing. Join The Startup’s +787K followers.

Sign up for Top 10 Stories

By The Startup

Get smarter at building your thing. Subscribe to receive The Startup's top 10 most read stories — delivered straight into your inbox, once a week. Take a look.

By signing up, you will create a Medium account if you don’t already have one. Review our Privacy Policy for more information about our privacy practices.

Check your inbox
Medium sent you an email at to complete your subscription.

Pratik Kumar

Written by

Writes about Data Science, Deep Learning, and Programming (https://pr2tik1.github.io)

The Startup

Get smarter at building your thing. Follow to join The Startup’s +8 million monthly readers & +787K followers.

Pratik Kumar

Written by

Writes about Data Science, Deep Learning, and Programming (https://pr2tik1.github.io)

The Startup

Get smarter at building your thing. Follow to join The Startup’s +8 million monthly readers & +787K followers.

Medium is an open platform where 170 million readers come to find insightful and dynamic thinking. Here, expert and undiscovered voices alike dive into the heart of any topic and bring new ideas to the surface. Learn more

Follow the writers, publications, and topics that matter to you, and you’ll see them on your homepage and in your inbox. Explore

If you have a story to tell, knowledge to share, or a perspective to offer — welcome home. It’s easy and free to post your thinking on any topic. Write on Medium

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store