Skip to content

Releases

README Templates v1.7.0

Choose a tag to compare

@github-actions github-actions released this 08 Nov 12:48

What's new in 1.7.0

Five professional templates

  • Annual Report: your year as a shareholder report, with a serif cover, key figures that roll into place like an odometer, a monthly bar chart and your languages as a portfolio.
  • Ticker: your year as a listed stock, with weekly candlesticks of your activity, a ticker symbol from your username (or your own) and a scrolling tape of your repos.
  • Intaglio: an engraved certificate in the manner of a banknote, with a fine-line medallion drawn from your year, your name in engraved capitals and a seal that stamps down.
  • Departures: a split-flap departures board where every letter flips into place. Your projects are the flights, and what you're working on now is boarding.
  • Swiss: a Swiss-style typographic poster with a strict grid, one red and your contributions set as an oversized figure.

Made for founders, executives and senior engineers

  • Each new template has fields for your title and organisation. Annual Report also lists up to three highlights.
  • Your name, role and projects stay as plain text, and every number comes from your public GitHub activity.
  • Each has its own themed GitHub Sponsors page.
  • Search "Professional" on the Templates page to see all five.

Download the installer for your system below, or use Check for updates in the app.
Windows: *_x64-setup.exe · Debian/Ubuntu: *.deb · Fedora/openSUSE: *.rpm · any distro: *.AppImage
The *_store-upload.msix file is only for Microsoft Store submission and can't be installed directly.

README Templates v1.6.0

Choose a tag to compare

@github-actions github-actions released this 03 Nov 19:10

What's new in 1.6.0

Save your details

  • Data presets: save your name, links and options once, then switch to them instead of retyping. Choose a default that loads when the app opens.

Links and support

  • Add 54 platforms with real brand badges, including Instagram, YouTube, LinkedIn, GitHub Sponsors, Buy Me a Coffee, Ko-fi and Patreon.
  • Your GitHub Sponsors badge appears by itself if you have a Sponsors profile, and links you already list on GitHub fill in when you connect.
  • Optional sponsor wall: thank your public sponsors in your README, grouped into top, monthly and one-time, without showing any amounts. Private sponsors are never included.

GitHub Sponsors pages

  • Every template now has a second form: a themed page for your GitHub Sponsors profile, with its own data and presets.
  • Upload the artwork, then copy and paste the text into your Sponsors dashboard. Your README isn't changed.

Also new

  • An About screen with ways to support the project.
  • A clear message if the WebView2 runtime is missing on Windows.
  • The Microsoft Store version updates through the Store.

Download the installer for your system below, or use Check for updates in the app.
Windows: *_x64-setup.exe · Debian/Ubuntu: *.deb · Fedora/openSUSE: *.rpm · any distro: *.AppImage
The *_store-upload.msix file is only for Microsoft Store submission and can't be installed directly.

README Templates v1.5.0

Choose a tag to compare

@github-actions github-actions released this 23 Oct 20:57

What's new in 1.5.0

New template: Pacman

  • Your year as an arcade maze: your contribution calendar becomes the board, with a pellet for every day (bigger on busier days) and your busiest days as the power pellets.
  • The walls are generated from your username and mirrored like a real arcade board, with a wrap-around tunnel, and your name lights up in the same neon tubing (accents included).
  • After READY!, a demo game plays: the chomper eats its way to a power pellet, powers up and hunts down the ghosts, which are your featured repos. Each one pops its stars and floats home to the pen. The HUD keeps score: contributions, best day, streak and your level.
  • Scoreboard: meet the ghosts, one per project, then your numbers as a ranked high-score table and your languages as bonus items.
  • End card: an intermission chase, then the chomper writes out your sign-off: "Thanks for playing!"
  • Options: your player class and the closing line.
  • Animated, with dark (arcade screen) and light (printed) versions, and it respects reduced motion.

Download the installer for your system below, or use Check for updates in the app.
Windows: *_x64-setup.exe · Debian/Ubuntu: *.deb · Fedora/openSUSE: *.rpm · any distro: *.AppImage

README Templates v1.4.0

Choose a tag to compare

@github-actions github-actions released this 22 Oct 18:35

What's new in 1.4.0

New template: Breakdown

  • Dedicated to Vijay Pratap Pandey, VFX compositor (vijayvisuals.github.io).
  • Your year as a visual-effects shot breakdown, made for CG artists: a city with one tower for every day, laid out like your contribution calendar and receding week by week toward a setting sun.
  • The city extrudes in date order while the timeline plays frames 1001 to 1365, then the frame wipes through the render passes (wireframe, clay, normals, depth) to a dusk beauty pass with lit windows, street lamps and an anamorphic flare. Your name is lettering in the scene, so every pass renders it.
  • Comp script: your repos as a node graph, each with a material-preview thumbnail in its language colour, plus a render log of your year and your languages as a colour chart.
  • End card: the on-set reference kit (grey ball, chrome ball, colour chart) and a sign-off: "Thanks for watching."
  • Options: your discipline, a showreel link, your toolkit and the closing line.
  • Animated, with dark (dusk) and light (hazy morning) versions, and it respects reduced motion.

Download the installer for your system below, or use Check for updates in the app.
Windows: *_x64-setup.exe · Debian/Ubuntu: *.deb · Fedora/openSUSE: *.rpm · any distro: *.AppImage

README Templates v1.3.0

Choose a tag to compare

@github-actions github-actions released this 22 Oct 03:05

What's new in 1.3.0

New template: Fathom

  • A cinematic dive, drawn from your GitHub data: the camera leaves the sunlit surface and sinks onto a living reef, glowing plankton swirls together into your name, and a depth gauge settles at your depth, one metre for every contribution, in the ocean's real zones (sunlit, twilight, midnight, abyssal, hadal).
  • The reef is your year: one coral per week, as tall as that week was busy, and a glowing polyp for every day you contributed. Your featured repos swim past as fish, sized by their stars.
  • Dive log: your year drawn as one descent through the zones, with a bubble for every active day and the date you reached each new zone. Plus a logbook page with a dive-centre stamp, your languages as "species spotted", and your repos on sonar.
  • A sign-off at the surface, beside a diver-down buoy and a message in a bottle: "Thanks for diving in."
  • Options: the name of your dive site, the closing line and the postscript.
  • Animated, with dark (a glowing night reef) and light (a sunlit reef) versions, and it respects reduced motion.

Download the installer for your system below, or use Check for updates in the app.
Windows: *_x64-setup.exe · Debian/Ubuntu: *.deb · Fedora/openSUSE: *.rpm · any distro: *.AppImage

README Templates v1.2.0

Choose a tag to compare

@github-actions github-actions released this 21 Oct 22:14

What's new in 1.2.0

New template: ADHD

  • A cinematic opening shot, drawn from your GitHub data: a camera's autofocus hunts through a storm of notifications, open tabs, a sticky note and a to-do list, then locks onto your name. The colours snap together, a lens flare fires, and everything else fades into the background.
  • The soft lights behind your name are your year, one per month, brighter for busier months.
  • Signal: a browser with far too many tabs open, your projects among the rabbit holes. Inside, your last 365 days drawn as a seismograph with your biggest hyperfocus streaks marked, a clock with only two times on it (now, and not now), rolling counters for your stats, and your languages as "dopamine by source".
  • A film-slate sign-off: "Thanks for your attention. I know it's a limited resource."
  • Options: the thought on the sticky note, the closing line and the postscript.
  • Animated, with dark and light versions, and it respects reduced motion.

Download the installer for your system below, or use Check for updates in the app.
Windows: *_x64-setup.exe · Debian/Ubuntu: *.deb · Fedora/openSUSE: *.rpm · any distro: *.AppImage

README Templates v1.1.0

Choose a tag to compare

@github-actions github-actions released this 21 Oct 19:49

What's new in 1.1.0

New template: Dollhouse

  • A pastel-pink doll's-house room drawn from your GitHub data. Your name drops in as glossy bubble letters, a doll floats down on heart balloons, and a cool cat gets its heart-shaped sunglasses.
  • A heart garland of 52 bulbs, one per week, lit by your weekly contributions.
  • A diary page: an instant photo develops into your year as a heart of tiny hearts, stickers for contributions, streak, followers and stars, and your top languages as nail-polish bottles.
  • A letter-bead bracelet sign-off with your own message.
  • Options: speech bubble, the cat's name and the sign-off. The doll and the cats' looks are picked from your username.
  • Animated, with dark and light versions, and it respects reduced motion.

Desktop app

  • New title bar that matches the app. The white system bar is gone; the app's own top bar now moves the window (drag it, double-click to maximize or restore).
  • Minimize, maximize and close buttons in the app's dark style: Windows-style on Windows, GNOME-style round buttons on Linux.

Download the installer for your system below, or use Check for updates in the app.
Windows: *_x64-setup.exe · Debian/Ubuntu: *.deb · Fedora/openSUSE: *.rpm · any distro: *.AppImage

README Templates v1.0.0

Choose a tag to compare

@github-actions github-actions released this 21 Oct 15:11

Download the installer for your system below, or use Check for updates in the app.
Windows: *_x64-setup.exe · Debian/Ubuntu: *.deb · Fedora/openSUSE: *.rpm · any distro: *.AppImage