DEV Community

Cover image for How to Add a README File to Your GitHub Profile
Idris Olubisi💡
Idris Olubisi💡

Posted on

How to Add a README File to Your GitHub Profile

Hi guys! I trust y’all had a good day?

Our focus today is the amazing special feature for developers, designers, etc. that was added by GitHub recently. This feature allows you to showcase yourself not just by building but by adding information about your work, portfolio, and anything else on your GitHub Profile.

Have got some favorites readme I will like to share with you before we proceed:





Now let's create something magical 🤗

Some prerequisite :

  • Create a GitHub account
  • Basic Markdown knowledge for a smooth experience

Steps are as follows:

  • Create a new public repository with your username and ensure you use the same case as your GitHub username.


  • Click on the checkbox: Initialize this repository with a README file. This will create a file inside your repository.


  • Now you can edit the readme to your taste. Remember, you can add images, text, lists, etc. You also get a free template from GitHub out of the box.


You can check out a special 😎 repository on my Profile


Link to useful Resources

At the end of this article, you have successfully set up your special repository.

I hope you find this article useful :)

Share a Link to your GitHub profile in the comment section, we will be glad to check it out 😉

Top comments (6)

rahuldkjain profile image
Rahul Jain

Tired of updating GitHub profile README with the latest features again & again?

If yes, then I have developed a tool to do the same for you in just 1 click 🤓

🚀 Try the tool: live tool

If you find the tool useful, show some love by giving a ⭐ on ⭐️ repo

GitHub logo rahuldkjain / github-profile-readme-generator

🚀 Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI.

GitHub Profile Readme Generator

GitHub Profile README Generator

github-profile-readme-generator licence github-profile-readme-generator forks github-profile-readme-generator stars github-profile-readme-generator issues github-profile-readme-generator pull-requests join discord community of github profile readme generator

github-profile-readme-generator gif

View Demo · Report Bug · Request Feature

Loved the tool? Please consider donating 💸 to help it improve!

sponsor github profile readme generator Buy Coffee for rahuldkjain Buy Me A Coffee

Tired of editing GitHub Profile README with new features? This tool provides an easy way to create a GitHub profile readme with the latest add-ons such as visitors count, github stats, etc. 🚀 Demo

Try the tool: GitHub Profile README Generator

🧐 Features

Just fill in the details such as Name, Tagline, Dev Platforms Username, Current Work, Portfolio, Blog, etc. with a minimal UI.

  • Uniform Dev Icons

  • Uniform Social Icons

  • Visitors Counter Badge

  • GitHub Profile Stats Card

  • GitHub Top Skills

  • GitHub Streak Stats

  • Dynamic Dev(.)to Blogs (GitHub Action)

  • Dynamic Medium Blogs (GitHub Action)

  • Dynamic Personal Blogs from RSS Feed (GitHub Action)

  • Wakatime Stats contribute

  • Buy Me A Coffee button

Click on Generate README to get your README in markdown

olanetsoft profile image
Idris Olubisi💡 • Edited

This is super cool 😎 @rahuldkjain

ptprashanttripathi profile image
Pt. Prashant tripathi • Edited

Hey guys check out mine, and give some valuable feedback

olanetsoft profile image
Idris Olubisi💡

Awesome design

miguelmj profile image

I modified mine a lot until I was happy with it. Let me know you thoughts! Criticism is welcome.

olanetsoft profile image
Idris Olubisi💡 • Edited

I love the simplicity @miguelmj you rock 🎉