Akshu-on-github / Make-your-own-README.md

Step by step to make your own ✨special✨ repository - a.k.a the GitHub README.md

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Sample of README.md in Dark Mode Sample of README.md in Light Mode
Demo readme.md in dark mode Demo readme.md in light mode

Header image

<img src="PATH" alt="IMAGE_DESCRIPTION" width=100%>
TODO:
  1. Add an image source: Upload a png, svg, jpeg or gif and replace PATH in the image tag with the url/path
  2. Add alternate text: Replace the IMAGE_DESCRIPTION in the image tag with a short description of the image for better accessibility

Github Stats Card

To customize your cards, check out the source code

My Github Stats

![My Github Stats](https://github-readme-stats.vercel.app/api?username=INSERT_USERNAME&show_icons=true&hide=stars&theme=radical)]

Top Langs

![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=INSERT_USERNAME&layout=compact&theme=radical&card_width=275)]
TODO:
  1. Replace INSERT_USERNAME with your GitHub username in the parameter username=INSERT_USERNAME in both cards

Regular Updateables

Note: I'd reccomend updating these once a week, maybe each Sunday afternoon

🌱 Currently Learning:

  • Topic_name

🍃 Current Projects:

✨ OpenSource Communities:

💬 Social Handle Badges

<a href="SOCIAL_PROFILE"><img src = "https://img.shields.io/badge/SOCIAL_PLATFORM-SOCIAL_HANDLE-blue?style=for-the-badge&logo=SOCIAL_PLATFORM&logoColor=white"></a>
TODO:
  1. Replace SOCIAL_PLATFORM to the social media handle of your choice (eg: LinkedIn, Twitter, etc.)
  2. Replace SOCIAL_PROFILE to the link to your profile on the social media platform
  3. Replace SOCIAL_HANDLE to your username on the social media platform

📛 My Badges:

<img src="PATH" alt="IMAGE_DESCRIPTION" width=50px>
TODO:
  1. Add an image source: Upload a png, svg, jpeg or gif and replace PATH in the image tag with the url/path
  2. Add alternate text: Replace the IMAGE_DESCRIPTION in the image tag with a short description of the image for better accessibility

About

Step by step to make your own ✨special✨ repository - a.k.a the GitHub README.md

License:MIT License