Creating an awesome GitHub profile readme!!
Ah, readme files — those markdown files that are generated whenever you start a new GitHub repository or project. Perhaps you give your project some description, or you are a developer who occasionally updates the Readme file, or you are a developer who leaves the boilerplate alone. In any case, I have the tutorial you require.
GitHub now enables developers to set up a profile-level repository and customize their page’s README.
I’ve been aware of it for some time, and this is my profile:
Many developers inject a lot of ‘cool’ widgets and badges in their profile instead of highlighting what makes them unique , thus I encourage you to make your own list — what do you want on your profile?
How is it going to highlight what makes you unique?
Your Very Own Repository
Go to GitHub and create a new repository with the same name as your username and initialize the file with Readme.md and .gitignore files.
Once you have created a repository , clone it and then open it in your favourite repository.
The README Template
You will most probably need to make an extra readme file to edit your content — a raw version of your readme file that will be used to construct your readme file. I would recommend you to name it README.template.md for your own convenience.
Banner Image
You can add a banner image to your profile of your liking which can be used to greet others. Place the image in the root folder of the project so that it’s easily accessible to the project.
Syntax :
Social badges
As one of my main goals is to reach out to as many visitors as possible , social media handles can be a good way to introduce yourself and your official portfolio present on platforms such as LinkedIn , twitter , Instagram , CodePen, LeetCode etc.
To create badges visit shields.io which is a great tool that will help you to create your own badges.
To create your very own visitors badge , copy the “Visits Badge” markdown content below and change the repository destination in the URL(everything after ‘/visits/’).
The Introduction Section
The Profile badges and banners don’t take up much space so introduce yourself, perhaps a new project you are working on or simply put a short intro and a link to your portfolio website which will save the time of the reader as well as efforts to know you better.
Latest Blog Posts
Now If you have some blogs published on platforms such as dev.to, hashnode, medium then you can share them as well.
In your readme file use the following format :
To inject the blog feed into the README.md file use the following link: How to add Your Recently Published Articles to your GitHub Profile Readme using GitHub Actions 🤖
Pinned Repository & GitHub Stats
Here the developer can highlight projects they are working on currently or shift the spotlight to one of the best projects they have worked on.
Here is a resourceful link to customize and get cards with good design to represent your repository : Anurag Hazra‘s GitHub ReadMe Stats
Your Readme File :
Now every developer needs to show visitors their skills as a developer and the tech stack they follow.
You can again use shield.io and display the technology and match it consistently with the background of the GitHub webpage to maintain the uniformity of the profile.
The Office Quote
Before visiting your profile a short positive quote would help provide the profile a good personal touch which can be inserted in the following way :
Let’s go! Now that you have all you need to create a stellar GitHub profile README, get to work!
Recall that your GitHub profile is similar to your portfolio; leverage it as a showcase for what sets you apart from other developers.
Send me a link in the comments below once you’ve done creating your own README for your GitHub profile! I would like to check over it!
Thanks for reading!
Additional Resources :
1.Profile Generator :
