Menu

Add a living pixel-art koi to your GitHub profile README (in 5 minutes)
πŸ“°

Add a living pixel-art koi to your GitHub profile README (in 5 minutes)

DEV Community: githubΒ·Luis A. GuisadoΒ·6 days ago
#eGBPEQDe
#devtogithub#technology#devto#dev#github
Reading 0:00
15s threshold

Your GitHub profile README can do more than list tech badges. With git-koi you get a small pixel-art koi that is redrawn every night from your public activity : languages color it, contributions make it grow, and streaks mark it.

I added it to my own profile today, and it took a few minutes. Here is exactly how, plus the three things that surprised me.

Credit: git-koi is an open source project (MIT license) by yalongwastaken . I'm only showing how to set it up.

What you need

A profile repository : a public repo named exactly like your username (for example PushoDev/PushoDev ). Its README.md is what GitHub shows on your profile.

Nothing else. The Action uses the built-in GITHUB_TOKEN , so there are no secrets to create, and you don't need Rust or the GitHub CLI.

Step 1: add the workflow

Create the file .github/workflows/koi.yml in your profile repo:

name : Koi

on : schedule : # Just after midnight UTC, so the koi shows the day that just ended.…

Continue reading β€” create a free account

Join HashtagPLUS to read full articles, follow hashtags, vote, and join the conversation.