v1.6.0

About card

• Words in the accent colour: put them between asterisks, anywhere in the headline, lines or facts. On a one-colour dot matrix or OLED display, the rest of the line is dimmed instead.

  cards:
    about:
      headline: "Hi, I'm *Pedro*"

• Lines wrap instead of being cut short.

• When it doesn't all fit, the bottom row is kept for the facts, which take turns there. The lines come in one by one, scroll up slowly just as far as the last one, and crossfade back to the start.

Weekly rhythm

Narrower bars, and beside them your busiest day, your quietest day and how much of your work is on weekdays. In every style.

Streaks

• Fixed: the card counted all time; it now counts the last 12 months, like the other cards.
• Classic: three pages sliding one way, two columns of numbers at a time. The bars under them show the year day by day, and their highlight moves to what the bottom-left number is about: the longest streak, the best month, then every active day.

Classic colours

• Fixed: on light pages, the weekly bars were palest on the busiest days. They're now darkest there, in every colour.

Setup

• The README step is called Update, and the run is First run only on a new setup.
• The wait for the first cards says 30-60 seconds, closer to what it takes.
• The about card's headline suggests Hi, I'm *your name*.

Upgrading

Nothing to do: workflows on @v1 get it on their next run. To change your settings, run setup again:

bash <(curl -fsSL https://raw.githubusercontent.com/pedrocatalao/github-cool-readme/v1/setup.sh)

v1.5.1

More colours

look.color can now also be purple, cyan, red or blue, in every style:

• Dot matrix and OLED: a bright shade on the colour's own dark panel, and a darker one on light pages without the panel, so it stays readable.
• Classic: the ring, the weekly bars and the streaks highlight take the colour, in shades for light and dark.

look:
  style: dotmatrix
  color: purple

Setup offers them too, each with its own dark panel for the background.

Setup

• Fixed: in a terminal narrower than a screen's lines (an 80-column one, on the cards screen), each key press left a line behind. Screens now redraw by the lines they take, wrapped ones included, and the hints are shorter.

Upgrading

Nothing to do. Run setup again to pick a new colour:

bash <(curl -fsSL https://raw.githubusercontent.com/pedrocatalao/github-cool-readme/v1/setup.sh)

v1.5.0

A new settings layout

cool-readme.yml now has five parts: who you are, which cards to show, what to count, how they look, and each card's own settings.

user: null
show: [summary, languages, contributions, weekly]   # in README order; also: streaks, about
count:
  private: true
  orgs: true
look:
  style: classic        # classic, oled or dotmatrix
  color: github         # github, amber or green
  animations: true
  background: none      # or a colour without #, like 030506
  border: false         # classic only
cards:
  summary: { ring: percent }
  languages: { hide: [], repos: {} }      # repos: a weight each; 0 leaves one out
  contributions: { open: true, pin: [], hide: [] }
  about: { headline: null, lines: [], facts: {} }

Settings in the old layout still work and look the same. Running setup again moves them to the new one, comments kept. See the README's Settings section for every option.

Cards and looks

• Two new cards, off by default: streaks (current and longest streak, active days, best day and month) and about (a headline, lines and facts of your own).
• Three styles: classic, dotmatrix (round LEDs, what oled used to be) and oled (square pixels, what matrix: false used to be).
• color for every style, github by default. On classic cards, amber and green colour the ring, the weekly bars and the streaks highlight. The OLED colour theme is now called github.
• background: none (now the default for every style) or a colour of your own, the same for every viewer, the text in shades that suit it. Without a panel, amber and green go darker on light pages so they stay readable.
• The display cards' shine now sweeps right off the card, and the streaks green is brighter in light mode.

Setup

• Moves your settings to the new layout, and asks for the about card's text when it's on and empty.
• Space and the arrows instead of number keys: ↑↓ choose, space changes, Shift with ↑↓ moves a card. Every choice shows ● or ○, and the screens no longer flicker.
• A new COOL README banner; the star always shows, and asks only if you haven't starred the repo.

Upgrading

Nothing breaks: the action reads both layouts. Display cards that never set transparent lose their dark panel (set background: 0d0b07 to bring it back), and style: oled becomes dotmatrix with the same look. To move to the new layout and try the new options, run setup again:

bash <(curl -fsSL https://raw.githubusercontent.com/pedrocatalao/github-cool-readme/v1/setup.sh)

v1.4.2

Setup

• Choose the order of the cards. The Cards screen is a list, one row per card in README order: the cards that are on at the top, those that are off below. A row's number turns its card on or off; ↑↓ move the marked card among the ones that are on. The order is kept in cards: in cool-readme.yml and used for your README.
• A new banner: the COOL README title in colour, with the star beside it. The star and countdown need a terminal at least 57 columns wide.

Upgrading

Nothing to do. Run setup again to change the order of your cards:

bash <(curl -fsSL https://raw.githubusercontent.com/pedrocatalao/github-cool-readme/v1/setup.sh)

v1.4.1

Setup

• The block setup writes in your README credits the project, in a comment that isn't shown on your profile:

  <!-- Cards by github-cool-readme: https://github.com/pedrocatalao/github-cool-readme -->

Upgrading

Nothing to do. Your README gets the comment the next time you run setup.

v1.4.0

Cards

• Every card is 400 by 195 on the page, classic or OLED, so two always fit a row.
  • Classic cards are all 400 wide (they were 450 and 350). Languages and weekly use the extra room; contributions keep their layout, with the stars closer to the names.
  • OLED cards are 450 by 219 (8 more dot rows), shown at 400. Dots and text keep their size; the weekly bars get taller.
• The classic summary shows one column of numbers that flips between the last 12 months and all time, row by row, each staying 3.5 seconds, like a page of the contributions card. Without animations (or with reduced motion) it shows all time.
• The cards can be turned off: cards: [] makes none. The action finishes without calling GitHub, and the workflow publishes nothing.

Setup

• Opens with a banner. If you haven't starred the repo, a star beside it asks you to: it's lit, 1 turns it off, and setup goes on by itself after 4 seconds or on Enter.
• Yes/no questions work like the other screens: [1] (or ←/→) switches, Enter continues. Keys show as [1], [2]… and everything lines up.
• Turn every card off to switch the cards off: they leave your README (the marked block stays, so they come back in the same place), the workflow loses its schedule but can still be run by hand, and the settings and first run are skipped. Turn a card on again to bring it all back.
• A token that's set isn't asked about. If the first run fails on it (expired, revoked or missing a scope), setup offers to replace it and runs again.
• Fixes: a pasted token is no longer shown as you paste it; keys typed right after an arrow key are no longer lost.
• --no-commit goes through everything but commits, pushes and runs nothing, for trying setup out.

Upgrading

Workflows on @v1 get the new cards on their next run. Run setup again to update your README: it asked for the classic cards at 450 and 350 wide, and they're now 400, so until then two of them show slightly scaled up and two slightly down.

bash <(curl -fsSL https://raw.githubusercontent.com/pedrocatalao/github-cool-readme/v1/setup.sh)

To turn the cards off, setup also updates your workflow: say yes when it asks.

v1.3.1

Fixes

• Setup stops its background jobs when it exits. Before, a setup stopped with Ctrl-C while starting the first run kept a job running, and the next setup could print …/run: No such file or directory. Harmless, but noisy.

README

• The setup command is at the top, with what it does and the steps by hand in the Setup section.

Upgrading

Nothing to do: the setup command always fetches the latest v1, and workflows on @v1 are unchanged.

v1.3.0

Cards on their own branch

The workflow now publishes the cards to a cards branch of your profile repo instead of committing them to stats/ on your main branch. The branch holds a single commit, replaced whenever the cards change, so your main branch's history no longer grows with every update.

• The README loads the cards from https://raw.githubusercontent.com/<you>/<you>/cards/…
• When nothing changed, nothing is pushed

Every 2 hours

The workflow runs every 2 hours instead of once a day. With the cards off your main branch, frequent runs cost nothing in its history.

Upgrading

Workflows on @v1 keep working as before: they still commit to stats/. To move to the cards branch, run setup again and answer y to "Update it?":

bash <(curl -fsSL https://raw.githubusercontent.com/pedrocatalao/github-cool-readme/v1/setup.sh)

Setup updates the workflow and starts a first run. Once that run has made the cards on the branch, setup points the README at them and removes stats/ in one commit. Until then, your README stays as it is.

By hand: copy the new profile-workflow.yml, run it once, then change the image URLs in your README and delete stats/.

v1.2.0

Choose your cards

Show any of the four cards, not just all of them. In cool-readme.yml:

cards: [summary, contributions, weekly]   # default: all four

• The action makes only the listed cards
• Setup has a new Cards section before the settings: press 1-4 to turn a card on or off, then Enter
• The README block follows your choice, two cards per row
• A card you turn back on goes into the README after the first run has made it, so there's never a broken image

Setup

• The settings screen starts with private repos, org repos and style; colour, dots and background only appear with the oled style
• Esc quits at any question
• Run it again to change the cards, style, colour or what's counted

Upgrading

Workflows on @v1 pick this up automatically. To change your cards, add cards to cool-readme.yml, or run setup again so the README follows too:

bash <(curl -fsSL https://raw.githubusercontent.com/pedrocatalao/github-cool-readme/v1/setup.sh)

v1.1.1

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: github works 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, color and transparent are 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; d shows 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)