Repository navigation
OLED cards
A second style for all four cards, drawn like the dot-matrix display on a pinball machine. Set it in cool-readme.yml:
style: oled # or classic, the default
color: amber # amber, green or theme
matrix: true # false: square pixels instead of round LEDs
transparent: false # true: no dark panel behind the dots- All four cards are the same size (450×195) and are shown at 400 wide, so two fit in a row
- Pinball transitions: sparkle dissolves, pushes, wipes, flashes and typewriter text; the weekly card scrolls like a score ticker
summary.ring: githubworks here too: the GitHub mark sits in the ring and the percentage moves to the title- Sharp in Safari and Chrome: the LEDs are real circles, with no masks or filters
matrix,colorandtransparentare ignored by the classic style
The classic cards are unchanged and still the default.
Guided setup
- A settings screen: press 1-6 to change style, colour, dots, background and what's counted; press Enter to continue
- Questions take one key, no Enter;
dshows the exact diff before a commit - Every question comes before the first run, so nothing waits for you after it
- The README widths follow the style (450/350 for classic, 400 for oled)
- Run it again to change settings; it only touches the settings you change
Upgrading
Workflows on @v1 pick this up automatically. To switch styles, change style in cool-readme.yml, or run setup again so the README widths match too:
bash <(curl -fsSL https://raw.githubusercontent.com/pedrocatalao/github-cool-readme/v1/setup.sh)