Skip to content

Badges

Your agent is the interface. The static badge below is a snippet to paste; the live ones need the project's published dashboard, and one sentence gets both — the agent installs the skill if it is missing, publishes the dashboard and puts the badge in the README. The installation page has the whole picture.

Install the Keep the Why skill if it isn't installed yet — pick the best installation method for you from https://keepthewhy.com/installation/ — then publish the Keep the Why dashboard and add its live badge to the README.

Three badges, one static and two live — take the one that fits, or two; one is enough. Plain SVG files at fixed URLs, nothing fetched from a badge service when a README is viewed. The project wizard offers the static one when a project starts with Keep the Why, and the live one once the dashboard is published with the docs — in place of the static one or next to it, your call. The two live ones are rendered by the dashboard export on every docs build with the project's own numbers — entries and open, where open counts every entry that still needs a person.

The static badge

Keep the Why

Says that a project uses Keep the Why — for any project, with or without a published dashboard. The snippet is the same for every project: copy it as-is, and paste it near the top of README.md, as the last badge if there are others already (it carries less load-bearing information than build status, license or version).

[![Keep the Why](https://keepthewhy.com/assets/badge.svg)](https://keepthewhy.com)
<a href="https://keepthewhy.com"><img alt="Keep the Why" src="https://keepthewhy.com/assets/badge.svg"></a>

The live badge: badge-entries.svg

Keep the Why · live

A project that publishes its dashboard with its docs gets a badge with its own numbers, linking to its own dashboard — the one above is this repository's. It can stand in for the static badge (one badge is enough) or join it. ktw-dashboard --export writes it beside index.html and state.json, rendered at export time — the build step and the dashboard-state line that go with it: CI linting setup, "The dashboard export"; the project wizard offers both when a docs build exists. https://example.org/keep-the-why-dashboard/ below is wherever the build puts the export.

In Keep the Why's style — the static badge's wordmark, extended by the numbers:

[![Keep the Why · live](https://example.org/keep-the-why-dashboard/badge-entries.svg)](https://example.org/keep-the-why-dashboard/)
<a href="https://example.org/keep-the-why-dashboard/"><img alt="Keep the Why · live" src="https://example.org/keep-the-why-dashboard/badge-entries.svg"></a>

The same numbers, flat: badge-entries-flat.svg

keep the why: entries · open

For a badge row in the flat style the badge services draw, where the styled one would stand out:

[![keep the why](https://example.org/keep-the-why-dashboard/badge-entries-flat.svg)](https://example.org/keep-the-why-dashboard/)
<a href="https://example.org/keep-the-why-dashboard/"><img alt="keep the why" src="https://example.org/keep-the-why-dashboard/badge-entries-flat.svg"></a>

Both live badges are static SVG written by the export: as current as the docs build, no request to any service when a README is viewed. Before dashboard 0.4.0 the export wrote one badge, badge.svg, in the flat style; it is gone — a README that still names it shows a broken image until the line names one of the two above.