Components/GitHub README

Pals for your GitHub README

Your words in pixel letters, with pals living on them: walkers patrol the tops of the letters, fliers bob above, the rest sit on a letter and do their thing. It's one image link, so it works on your GitHub profile, any README, a blog or a forum post. No scripts, nothing to install.

Text Up to 40 characters: letters, digits and most punctuation.

Pals Pick up to 4. Tap a picked one to drop it.

Star count Adds a live star count after your text, refreshed every hour.

Theme

Auto has no background and works on GitHub's light and dark modes.

Letter size Pal size Walking speed

Preview

Paste this into your README.md

Or as HTML

A few ideas

A profile hello, with a beetle, a bee and a triangle. piixpal.dvkk.dev/readme?text=Hi, I'm Ada&pals=bitbug,bumble,tri

A project banner with its live star count. `piixpal.dvkk.dev/readme?text=Piixpal&repo=diiviikk5/Piixpal&pals=penguin,pip&theme=dark`

Paper, smaller letters. `piixpal.dvkk.dev/readme?text=shipping daily&pals=gecko,scrolly&theme=paper&size=5`

Lime, with sparrows overhead. `piixpal.dvkk.dev/readme?text=open to work&pals=sparrows,nomad&theme=lime&scale=2`

All the options

text     what it says, up to 40 characters
pals     up to 4 pal names, comma separated            (bitbug)
repo     owner/name: adds the repo's live star count
theme    auto | light | dark | lime | paper           (auto)
color    the letters' colour, hex without the #
size     letter pixel size, 2 to 12                    (6)
scale    pal pixel size, 2 to 6                        (3)
speed    walking speed, 0.25 to 3                      (1)
width    image width in px                             (fits the text)
credit   0 hides the little "piixpal" in the corner

It respects prefers-reduced-motion, and GitHub caches the image, so a change can take a few minutes to show up.