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)