Skip to content

Instantly share code, notes, and snippets.

@EVanGorkom
Last active January 11, 2024 19:36
Show Gist options
  • Save EVanGorkom/fc2e7deade52df9d54bffa0af3271986 to your computer and use it in GitHub Desktop.
Save EVanGorkom/fc2e7deade52df9d54bffa0af3271986 to your computer and use it in GitHub Desktop.

How to Create a README for your GitHub Profile Walkthrough

Getting Started

Create a new repository that has the SAME name as your GitHub username. This will give you a notification that this is a special repostitory that will automatically live at the top of your profile page.

  • Make sure the repo is public
  • Make sure you initiate a README.md when your create this
  • (In the screeshot below it says I already have one because I've done this step already, you won't see this error)

Screenshot 2023-12-04 at 10 30 02 AM

Updating your README.md

Now that we have our new project setup, we can modify the README to showcase all of our information and skills. There's a lot of templates that exist online, but I ended up opting for a hybrid/made my own. You can customize these as much or as little as you like. I kept mine as an informal resume and repository of my skills and history.

My Template

Be sure to update the template with your own information where it says YOUR_USERNAME_HERE or YOUR_LINKEDIN_URL_HERE

# Your Name
### About Me:
Add a description

<a href="https://linkedin.com/in/YOUR_LINKEDIN_URL_HERE" target="_blank">
<img src=https://img.shields.io/badge/linkedin-%231E77B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white alt=linkedin style="margin-bottom: 5px;" />
  
---

# Languages, Frameworks, and Tools
<div align="center">
<a href="https://www.ruby-lang.org/en/" target="_blank"><img style="margin: 15px" src="https://upload.wikimedia.org/wikipedia/commons/thumb/7/73/Ruby_logo.svg/480px-Ruby_logo.svg.png" alt="Ruby" height="50" /></a>
<a href="https://rubyonrails.org/" target="_blank"><img style="margin: 15px" src="https://profilinator.rishav.dev/skills-assets/rails-original-wordmark.svg" alt="Ruby on Rails" height="50" /></a>
<a href="https://github.com/" target="_blank"><img style="margin: 15px" src="https://profilinator.rishav.dev/skills-assets/git-scm-icon.svg" alt="Git" height="50" /></a>
<a href="https://en.wikipedia.org/wiki/HTML5" target="_blank"><img style="margin: 15px" src="https://profilinator.rishav.dev/skills-assets/html5-original-wordmark.svg" alt="HTML5" height="50" /></a>
<a href="https://www.w3schools.com/css/" target="_blank"><img style="margin: 15px" src="https://profilinator.rishav.dev/skills-assets/css3-original-wordmark.svg" alt="CSS3" height="50" /></a>
</div>

---

# GitHub Statistics
<table><tr><td valign="top" width="50%">

<img src="https://github-readme-stats.vercel.app/api?username=YOUR_USERNAME_HERE&theme=radical&show_icons=true&count_private=true&hide_border=true" align="left" style="width: 100%" />

</td><td valign="top" width="39%">

<img src="https://github-readme-stats.vercel.app/api/top-langs/?username=YOUR_USERNAME_HERE&theme=radical&hide_border=true&layout=compact" align="left" style="width: 100%" />

</td></tr></table>

![Profile views counter](https://komarev.com/ghpvc/?username=YOUR_USERNAME_HERE&&style=flat-square)

<br />
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment