The Secret GitHub Repository ! 🤫
Tags: github, markdown, productivity, beginners
Published: 2021-06-17 12:59:44

Do you know that GitHub allows you to display a README on your GitHub profile through which you can convey information about yourself to other people? You can add information about yourself, your contributions and any other information that visitors may find interesting

## How to unlock the secret repository?
1. Go to your [GitHub](https://github.com/new) account and create a new repository and make sure it's **identical** your **GitHub username**.
Keep the following prerequisites in mind while creating the repository.
 - The repository is public.
 - The repository contains a file named README.md in its root.
 - The README.md file contains any content.
 ![Screenshot of creating new GitHub repo](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/z73u1w3en5ff0pddfip9.png)
2. Go to the repository you just created. Open the README.md file and click on the pencil icon to edit. You will be presented with the following boilerplate markdown.  ![GitHub Readme](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/q3aizzlcnzilx8fdvkzd.png)
3. Uncomment the given markdown and edit as per your requirement. Commit the new changes and go to your GitHub profile you will see that the README.md file will appear on your profile! 
<hr>

## Editing and Customizing 
The readme file which we just created uses markdown.

### What is Markdown?
Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform. It is a very simple and straight syntax just go through the following guides and you will be all set.
- [Mastering Makrdown | GitHub Guides ](https://guides.github.com/features/mastering-markdown/)
- [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)

For editing your markdown file you need a text editor with markdown support. I prefer using [StackEdit](https://stackedit.io/) which is web based markdown editor. You can use any editor of your choice.     
### Things to add in your readme
1. **Bio**: Just keep it simple ! Mention your interests and what you do. Mention a fun fact about you. 
2. **Your Social Media**: Add your social media and contact links. For icons you can use [Flaticon](https://www.flaticon.com/) or [Simple Icons](https://simpleicons.org/).
3. **Your Skills**: You can mention your skills and projects that you are working on. Use  [shields.io](https://shields.io/) if you want to spice it up a little.
<img src="https://img.shields.io/badge/-HTML5-E34F26?style=flat-square&logo=html5&logoColor=white" height="25"> 
<img src="https://img.shields.io/badge/-CSS3-1572B6?style=flat-square&logo=css3" height="25"> 
<img src="https://img.shields.io/badge/-C-F7DF1E?style=flat-square&logo=C&logoColor=black" height="25"> 
<img src="https://img.shields.io/badge/-C++-00599C?style=flat-square&logo=c" height="25"> 
4. **Your GitHub Stats**:  Show your contribution using the GitHub stats.
 ![My GitHub Stats](https://github-readme-stats.vercel.app/api?username=pratik-kale20&theme=midnight-purple&show_icons=true&include_all_commits=true&count_private=true&hide=issues)
```
 ![My GitHub Stats](https://github-readme-stats.vercel.app/api?username=yourusername&theme=midnight-purple&show_icons=true&include_all_commits=true&count_private=true&hide=issues)
```
 
Copy this link in your file and replace yourusername with your GitHub username. That's it, it will show your stats.
You can customize the look and feel of the stats. Refer to the following link for more information : [GitHub Stats Customization](https://github.com/anuraghazra/github-readme-stats#:~:text=if%20you%20like%20%3AD-,Customization,-You%20can%20customize)

5.**Title Image** : You can add a custom title image like this.
![Title Image](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/uyookx2olhwov7epmeok.jpg)
You can design images like these using Adobe Illustrator or [Canva.](https://www.canva.com/en_gb/)

6.**Visitors Count**
This will show how many people visited your GitHub profile.
<img  src="https://profile-counter.glitch.me/pratik-kale20/count.svg" />

    <img  src="https://profile-counter.glitch.me/username/count.svg" />
Replace username with your GitHub username.

I have just scratched the surface here. There are a lot of things you can do. Explore the repositories I have given below so that you can have inspiration for your own readme.
<hr>

## Templates 
### My GitHub Profile
{%github pratik-kale20/pratik-kale20 no-readme%}
### Template Collection
{%github durgeshsamariya/awesome-github-profile-readme-templates no-readme%}{%github abhisheknaiidu/awesome-github-profile-readme no-readme%}
<hr>

And there you have it! Your own GitHub readme. If you know any cool ideas for profile readme do let me know in the comments.

Reach Me:
[Twitter](https://twitter.com/Pratik_kale135) | [Instagram](https://www.instagram.com/prato.grapher/) | [Mail](mailto:pratikkale135@gmail.com)