Now that you know what basic changes you can make to your GitHub profile lets move further.
Despite pinning your popular repositories and adding a contributions graph, there is a lot more you can do with your GitHub profile. By adding a sparkling README.md file, you are going to take your profile to The Next Level! In this blog, we are going to learn about how to add a README.md file and about the different elements to enhance it! And stay tuned till the end because there is a surprise waiting up for you!
Fun Fact: README.md is a markdown file (md stands for markdown). Markdown is easier to write & read than HTML source. However, HTML is more expressive and can achieve some specific effects that may be difficult to achieve with Markdown.
Having basic knowledge about markdown would help you write your README.md file. You can go through this Markdown Cheat Sheet really quick before you start writing your README file.
# Adding a README.md file: To find a secret
To begin with, you need to create a new repository with the same name as your GitHub username.
To make a new repository: In the upper-right corner of any page, use the drop-down menu, and select New repository.
As soon as you do so, GitHub prompts you to your new-found secret:
Just as the prompt says:
1. Make sure it’s public.
2. Initialize it with a README to get started.
README.md file initializes with a “Hi there 👋” message. Further, you can start editing it through the pen tool on the top right corner of your repository. The generated README file on GitHub is pre-populated with a template to give you some basic ideas to start with. You can uncomment it and fill the blank spaces. You can also add an “About me” section.
Note: You can also create this repository using your code editor & GitHub desktop, and then edit it from there. To do so:
Make a file: Your_Username/README.md -> Publish it on GitHub -> Make it public and voila!
1. Header Image/GIF: An attractive beginning
Having a header image gives your profile just the head start it requires. You can add an image with your name, proficient languages, and social media handles or make an interesting GIF for that. I would suggest Canva to create a personalized header for your readme.
You can also generate random header images. Here is an amazing repository for that:
2. Images, GIFs, Illustrations
- Image: Adding a welcome GIF of your favorite cartoon character/tv series is the new trend. I think it makes your profile more personal and gripping.
- Illustrations: Illustrations have taken a leap in recent years. Their popularity has bloomed, I see a lot of GitHub profiles including illustrations in their READMEs. Other than that, illustrations are geometrically symmetrical and extremely eye-catching.
3. Social media: Connect with fellow developers
For adding logos for your social media handles, Simpleicons is the way to go. You can go to their website and search for different logos. They also have a repository to help you with the usage:
This way it will be easier to reach out to you and build connections over GitHub.
4. Languages and frameworks: Let others know what you know
Don’t hold back from showing off your skills and frameworks. The icons for languages and frameworks come from GitHub itself. For example, the logo for JavaScript can be found on this link:
https://raw.githubusercontent.com/devicons/devicon/master/icons/javascript/javascript-original.svgThese are the three links you can try for any logo you are searching for:
1. https://raw.githubusercontent.com/devicons/devicon/master/icons/<iconname>/<iconname>-original.svg2. https://raw.githubusercontent.com/devicons/devicon/master/icons/<iconname>/<iconname>-line.svg3. https://raw.githubusercontent.com/devicons/devicon/master/icons/<iconname>/<iconname>.png
5. Stats, Top Languages, Repo stickers, & Wakatime card
Here is a repository to add amazing cards to your README file like GitHub Stats, Top Languages & repo stickers, and Wakatime card. This will help people know more about your open-source involvement and contributions.
- Wakatime card alternative:
- UTC time:
6. Badges: To honor your skills
If you want to add some cool badges to your README, Shields.io has a variety of badges to offer. The badges are customizable and highly flexible. They also have a repository to help you through:
Otherwise, if you just want to add something as simple as a visitors badge, here are some resources:
- Visitors badge:
- Some Useful badges for your GitHub README:
- Badges for everything:
7. Workflows
You can add several workflows to represent your recent activity. You can add a workflow for your Latest YouTube videos, StackOverFlow Activity, Medium posts, etc which will be automated by just adding a .yml file in your repository.
Here are amazing repositories to guide you through:
- GitHub activity:
- Latest YouTube videos and Blog posts:
- Latest Medium articles:
- Dynamically generated StackOverflow profile status:
- Dynamically generated images from your LinkedIn profile:
8. Random Dev Jokes: To make you laugh
Dev jokes are always a delight for developers, so why not have them on your profile!
Resources:
9. Spotify songs: Share your music
If you love music and want to share with others what you are listening to, Spotify-now-playing is another add-on to your profile!
Resources:
10. Last but not the least: Emojis/GIFs
Emojis can be a cherry on top of your profile. Add emojis or moving emojis(GIFs) to make your profile even more interesting.
Resources:
Moving emojis/GIFs:
These were the 10 awesome elements you can add to your README. You don’t need to add all of them, just include your favorite ones. Creativity is important, but don’t overdo it.
The Surprise!
GitHub Profile Readme Generator by Rahul Jain helps you generate a README file for you, all you have to do is check in your fields!
Tip: Some awesome GitHub profiles
Before you start creating your profile, here are some examples for you to draw inspiration from:
Note: Removing a profile README
If in any case, you choose to hide/discard your README, it is removed from your GitHub profile if any of the following apply:
- The README file is empty or doesn’t exist.
- The repository is private.
- The repository name no longer matches your username.
The method you choose depends upon your needs, but if you’re unsure, I would recommend making your repository private.
Voila!
Now, you have all the prerequisites needed to build an outstanding README for your GitHub profile! And you can proceed to make one for yourself.
