Open In App

How to add a README to your GitHub profile?

Improve
Improve
Like Article
Like
Save
Share
Report

Github has recently added a really cool feature that allows you to add a README to your GitHub profile.
It’s just like an “About Me” or “Bio” section for your GitHub. It can be used to showcase your skills, your hobbies, or anything that you want the world to know about you.

User can customize the Info on the README as per its choice. Adding a README to the GitHub profile is quite an easier task. You can follow the steps given below to do the same:

Step 1: Create a new repository with your GitHub username.

  • Go to https://github.com/new and enter the same name as your GitHub username into the Repository name field.

  • Leave the repo as a Public repo (by default).
  • Also, make sure to initialize it with a README to get started.

Step 2: Add some content to your README.

  • You can list all your projects, websites, social media links, and many more things to it.
  • You can use markdown formatting (https://guides.github.com/features/mastering-markdown/ ) to style the text or add images/links.
  • GitHub also gives some suggestions to get started:

Step 3: Commit the changes to add a ReadMe to your GitHub Account.

Adding other interesting stuff to you README!

You can even add Github Readme Stats, Github Extra Pins, and GitHub Profile View Counter in your README.

Adding Github Stats Card

Github readme stats allows you to simply add a markdown image link and it will show you realtime stats for your GitHub account.

Usage:

Copy and paste this line into your markdown content and change the ‘?username= value’ to your GitHubs’s username

![Github stats](https://github-readme-stats.vercel.app/api?username=yourGithubUsername)

Preview:

Adding Github Extra Pins

Github extra pins allow you to pin more than 6 repositories in your profile by using the GitHub readme profile.

Usage:

Copy-paste this code into your readme and change the username and repo.

![ReadMe Card](https://github-readme-stats.vercel.app/api/pin/?username=YourUsername&repo=YourRepositoryName)

Preview:

Adding GitHub Profile View Counter

You can track Github profile views and display them in your profile readme.

Usage:

  • Copy this workflow to your Pipedream account (https://pipedream.com/@/p_G6CNmN/edit?copy=true
  • Add the Profile views counter-image to your Github Readme (use your Pipedream endpoint URL)
    ![counter](https://[YourEndpoint].m.pipedream.net)

Preview:
Your profile views will be counted and displayed:

Finally, commit all your changes and view your cool Github profile.


Last Updated : 28 Jul, 2020
Like Article
Save Article
Previous
Next
Share your thoughts in the comments
Similar Reads