DEV Community

Cover image for 10 Standout GitHub Profile READMEs
Lee Reilly for GitHub

Posted on

10 Standout GitHub Profile READMEs

My good friend and colleague @bdougieyo is at Codeland today and is giving away early access to Codespaces to three lucky people who create a profile README (a new feature we quietly launched a few weeks ago).

If you're looking for some inspiration, or information on how to actually enable this on your profile, here are a few READMEs that have jumped out at me over the last few weeks. Everything from purely cosmetic and informational, to truly hacktacular, computationally expensive impressive, and entertaining works of art 👌🏻

1 Hello, world!

Set yourself apart from everyone else with a brief biography, colorful header image, and links to find you elsewhere on the web - just like @M0nica:

Fun fact: @M0nica just published a blog post about how to create a GitHub profile README. That's a great starting point if you're thinking about adding one yourself.

2 Show off your stats 💪🏻

I may have talked about this before elsewhere, but if you're using GitHub as a resume / portfolio, this nifty little tool from @anuraghazra can show off your stats in a nice way. Enabling it on your repository is pretty easy with github-readme-stats.

3 Don’t forget to sign the guestbook on your way out

My good friend @JasonEtco is always pushing GitHub, Actions. and just about everything else web-related to it's limits. He built a guestbook on his profile using GitHub Actions. I'm just waiting on the support for hit counters, webrings, dancing babies, etc. and we'll have come full circle!

Please help me: Consider dropping by Jason's profile page, and sharing a fun joke, or perhaps a completely random fun fact on his guestbook. He doesn't know about this post, so he'll hopefully have no idea where the comments are all coming from* 😂

* Note to self: remember to remove Jason's access to the server logs tomorrow...

4 Hit counter 1️⃣ 3️⃣ 3️⃣ 7️⃣

Speaking of numbers, display your profile’s visitor count with this nifty little SVG solution. If you're as old experienced as me, you'll remember when every web page used to have one of these. Thanks @sagar-viradiya!

5 Shall we play a game?

It was only a matter of time until someone added a game to their profile README. This community-powered Connect4 game does exactly what you imagine. Very impressive, @jonathangin52 💙 ❤️

6 Wouldn’t you prefer a good game of chess? ♞ ♖

I could really get on BOARD with more games on profiles. I'd definitely CHECK them all out...

You guessed it! You can also play chess thanks to this little gem from @timburgan. Simply click a link to create an issue with your move command, and a GitHub Actions Workflow will take it from there.

7 Speaking of games…

@ethomson's contribution to the world of profile READMEs is a Game of Life simulation with a familiar look and feel 💚

Behind the scenes it uses libraries called contributions (creating a data structure with a GitHub contribution graph) and dat-life (supporting a Conway's Game of Life implementation). Read more about it here.

8 Now playing in a README near you ♩ ♪ ♫ ♬

An SVG dynamically rendered with a Vercel serverless function, and integrated with the Spotify API? BOOM! You have yourself an image displaying what you're listening to. Bravo, @natemoo-re. Bravo 👏

I can't wait to get this spun up on my profile! 🤘

9 Self-updating README

@simonw's profile literally updates itself–with latest releases, blog posts, and things learned–using GitHub Actions. Simon goes into it in more detail in this blog post if you're curious how it works under the hood.

10 Jump to it!

Last, but not least. It might just be a GIF, but by golly, I've been watching it for hours. This familiar-looking animation captured by @saadeghi shows that even the addition of a simple image can add a bit of character to your profile, and make it really jump out.

Hopefully these examples have given you some fresh ideas to add your own profile README. Enabling it is easy. Simply follow these instructions. I'd love to see yours - be sure to leave a link in the comments below :)

Top comments (57)

Collapse
 
daviddalbusco profile image
David Dal Busco • Edited

The chess README is pretty slick!

I really enjoy the one of @brunnerlivio too, there's something "old'school cool" there.

👉 GitHub

Collapse
 
bdougieyo profile image
Brian Douglas • Edited

I am a fan of the old school and always a fan of the underrated marquee

Collapse
 
leereilly profile image
Lee Reilly

No kidding! The 80s 90s called...

https://dev-to-uploads.s3.amazonaws.com/i/oepsqowurv75zxayqcbw.gif

Source: github.com/bdougie

Thread Thread
 
mmbazel profile image
Mikiko Bazeley

Omg I love it!

Collapse
 
brunnerlivio profile image
Livio Brunner

Aww thank you!
At this point I want to mention, its inspired by fnkys awesome README. As well as sindresorhus tweet which helped me to build the marquee :-)

Collapse
 
wjimmycook profile image
Jimmy Cook • Edited

Here is my new github profile README
github profile

Collapse
 
leereilly profile image
Lee Reilly

💚💚💚💚💚

Collapse
 
wjimmycook profile image
Jimmy Cook

Lol amazing!

Thread Thread
 
leereilly profile image
Lee Reilly

The folks contributing to this Tweet show real... commitment...

Thread Thread
 
wjimmycook profile image
Jimmy Cook

Just happy to push my changes

Thread Thread
 
leereilly profile image
Lee Reilly

Gonna stash these jokes for later. Might be able to cherry-pick a few for an upcoming Dev post...

Collapse
 
phitgeek profile image
David Obodo

super nice

Collapse
 
avinal_ profile image
Avinal Kumar • Edited

Check this out. Coding Activity Graph on your Profile README. Uses WakaTime API to automatically update your stats every night.
github.com/avinal/Profile-Readme-W...
Heyy

Collapse
 
ryanlanciaux profile image
Ryan Lanciaux • Edited

Thank you for this excellent article - love this feature of GitHub, and seeing all the creative things people are doing. Especially pumped to see the visitor counter making a come back :D

If anyone wants to add the retro counter to their profile (like @sagar-viradiya's profile) you can add it like this.
![Visitor Count](https://profile-counter.glitch.me/{YOUR USER}/count.svg)

Slightly more expanded version of these instructions are available here :D

For anyone that's interested in making their own visitor counter, check out this guide I wrote on creating (or forking the GlitchApp) to make your own visitor counter. 🚀 The main gist of this one is you run a node+Express app (although it could be a serverless function, other language/framework, etc) that responds to an svg request with the next count. The headers should alert GitHub's caching layer to re-request the image every time.

Collapse
 
sagarviradiya profile image
Sagar Viradiya

Thanks for creating this!

Collapse
 
kush1101 profile image
Kushagra Bansal

Thanks for the information! Was looking for this. 😊

Collapse
 
leereilly profile image
Lee Reilly • Edited

Graphics are a bit blocky, but here's mine...

Collapse
 
jamesgeorge007 profile image
James George

Here's a GitHub Action that updates README with the recent activity of a user:-

GitHub logo jamesgeorge007 / github-activity-readme

Updates README with the recent GitHub activity of a user

GitHub Activity in Readme

Updates README.md with the recent GitHub activity of a user.

profile-repo


Instructions

  • Add the comment <!--START_SECTION:activity--> (entry point) within README.md. You can find an example here.

  • It's the time to create a workflow file.

.github/workflows/update-readme.yml

name: Update README

on:
  schedule:
    - cron: '*/30 * * * *'
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    name: Update this repo's README with recent activity

    steps:
      - uses: actions/checkout@v2
      - uses: jamesgeorge007/github-activity-readme@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Enter fullscreen mode Exit fullscreen mode

The above job runs every half an hour, you can change it as you wish based on the cron syntax.

Please note that only those public events that belong to the following list show up:-

  • IssueEvent
  • IssueCommentEvent
  • PullRequestEvent

You can find an example here.

Override defaults

Use the following input params to customize it for…

Collapse
 
puneetgopinath profile image
Puneet Gopinath

Hey James George, you no longer maintain it. So here is a fork of it to use instead:

GitHub logo Readme-Workflows / recent-activity

Add your recent activity to your profile readme!

Recent Activity

GitHub stars GitHub forks GitHub issues GitHub repo size Lines of code Discord Chat Contributor Covenant

This GitHub Action is a Fork of the original GitHub Activity Readme Action by jamesgeorge007.
Its our goal is to improve the original GitHub Action while also providing new features for the users.

Live Preview

This is an example live preview that is updated every time a commit is pushed using github actions.

Last Updated: Thursday, May 20th, 2021, 3:17:39 PM (GMT)

  1. ❗️ Closed issue #5 in Readme-Workflows/recent-activity
  2. 🎉 Merged PR #6 in Readme-Workflows/recent-activity
  3. 🗣 Commented on #3 in Readme-Workflows/recent-activity
  4. ❗️ Closed issue #4 in Readme-Workflows/recent-activity
  5. 💪 Opened PR #6 in Readme-Workflows/recent-activity

Settings

The Action currently has the following Settings that you can set through the with option.

Option Description Default Supported Placeholder
GH_USERNAME The User to get latest activity from Repository Owner
COMMIT_MSG The Commit Message to use when updating the README ⚡ Update README with the recent activity
MAX_LINES How many activities to display 5
Collapse
 
arturssmirnovs profile image
Arturs Smirnovs

Here is a tool that could help you to get started with github readme :)
Add description / social media / badges and other stuff with just few clicks..

GitHub logo arturssmirnovs / github-profile-readme-generator

GitHub profile readme generator allows you to create nice and simple GitHub profile readme files that will be included in your profile previews.

Github Readme Generator

Hi there 👋.

Check out this tool here.

Github Readme Generator

This project allows you to easily create attractive and simple GitHub Readme files that you can copy/paste in your profile. It's currently available in English and Spanish.

You can include things like headers, subtitles, skills, a banner image, additional information, social media links, badges and GitHub statistics.

Instructions

  • Go to: arturssmirnovs.github.io/github-pr...
  • Fill any inputs you like
  • Copy the code generated in the Code section
  • Create a new repository in your GitHub account with the same name as your GitHub username
  • Add a readme.md file to your new repository
  • Paste the copied code into the readme file and save
  • Enjoy!

Preview

Github readme generator

Top Contributors

@arturssmirnovs @max-programming @fx2000 @DenverCoder1

Resources Used

Name Repository Link
Github Readme Stats github.com/anuraghazra/github-read...
Github Profile Views Counter github.com/arturssmirnovs/github-p...
Github Profile Trophy github.com/ryo-ma/github-profile-t...
Github Readme Streak Stats github.com/DenverCoder1/github-rea...
Simple icons github.com/simple-icons/simple-icons
Simple Translator github.com/andreasremdt/simple-tra...
Collapse
 
ahmadsawalqeh profile image
Ahmad Sawalqeh

I used a combination of several tools to make this piece of art you can check it out here! GitHub Account

Collapse
 
ronaldohoch profile image
Ronaldo Hoch

Nice!
How do you made this Contribution Stats?

Collapse
 
harshalrj25 profile image
Harshal Jadhav

Here's mine which shows your latest medium blogs.
harshalrj25

checkout my repo github.com/harshalrj25/mediumblog-... to add medium blogs to your profile.

Collapse
 
sarveshmankar profile image
Sarvesh Mankar • Edited

Guys checkout my GitHub Profile :D
github.com/SarveshMankar

Feature to watch out:

  1. SVG for Username
  2. GitHub Stats
  3. Dynamic Updates of Quotes!

Also do checkout my GFG article on GitHub Actions and GitHub Secrets!
Dynamic GitHub Readme

Do let me know your reviews!