What really is GitHub readme?
Well, it is a special repository of your GitHub profile with the same name as your username which shows up on your profile if you make it public. So, having an impressive readme is definitely a plus 🚀 but you should not dedicate your whole time editing it all day long like me 🙂
My GitHub Profile Readme Story
You can see my GitHub readme: https://github.com/abhinavkashyap061/abhinavkashyap061
If you liked it, you can star it too or fork ✨
Mine is not that fancy but rather minimalistic as I like it 😋. When I first came across this feature of GitHub, I spent way too much time creating it, editing it, adding various fancy stuff directionless with little to no actual projects on my GitHub profile 😂
Now, I have divided my Readme into various sections (which I will talk about later on) which I update once every month or so.
Section 1: Introduction
The Introduction section is just about giving a brief idea to the reader about you.
I made a GitHub banner describing who I am, from Canva and added typewriter animation to it to give that extra sauce 👌.
Canva design was "Black Modern Personal LinkedIn Banner" by Kamala.
You can put links to your Portfolio, social media, etc.. in this section.
Section 2: About
Here you mention about your education/job whatever you are doing currently, what are you working/learning about related to the field of your expertise, and then mention what would you like to collaborate on with people it can be Open Sources, Blockchain, Machine Learning projects, etc...
Also, I mentioned my email id so that the people can reach me to talk about the relevant projects.
Section 3: GitHub Stats
This section gives information about the metrics of your GitHub account, how much stars you have earned, PRs you have made, Issues you have raised and many more..
Another stat card gives info about your consistency (PS: I am on a consistency streak of 36 days)
These amazing GitHub stat cards are made by the OG @anuraghazra 🙌
Link: https://github.com/anuraghazra/github-readme-statsJust add your username in these links and it will create dynamic stat cards for your profile.
You can also mention your choice of theme by adding the name of theme from https://github.com/anuraghazra/github-readme-stats/blob/master/themes/README.md in the theme param in the code below
GitHub metrics Card: https://github-readme-stats.vercel.app/api?username=< YOUR USERNAME >&show_icons=true&theme=< YOUR THEME >
GitHub Consistency Card: https://github-readme-streak-stats.herokuapp.com/?user=< YOUR USERNAME >&theme=< YOUR THEME >
Section 4: Latest Blog Posts
As I generated an interest in writing blogs, so I made a section which automatically updates whenever a blog is added to my dev.to account.
For this I referred to a video by codeSTACKr : https://www.youtube.com/watch?v=ECuqb5Tv9qIBecause I myself don't completely understand about this yml, workflows, cron jobs, etc. 🥺
Discussion (0)