Skip to content

Commit 68bd7c3

Browse files
committed
docs: merge live and compact into one badge format
Two visual formats (badge + share card); auto vs pinned is wiring only.
1 parent a174849 commit 68bd7c3

6 files changed

Lines changed: 39 additions & 44 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -134,16 +134,17 @@ deterministic scanner can claim.
134134

135135
## Show your maturity in your README
136136

137-
Harness Score ships **three branded SVG artifacts** — free, self-contained, no
137+
Harness Score ships **two branded SVG formats** — free, self-contained, no
138138
shields.io subscription:
139139

140-
| Artifact | Shows | Best for |
140+
| Format | Shows | Best for |
141141
|---|---|---|
142-
| **Live badge** (`harness-badge.svg`) | `harness` · `L4` | README row — updates when your level changes |
143-
| **Compact badge** (`badge-l0``l4`) | `harness` · `L3` | Pin a level (no long name) |
142+
| **Badge** (`harness-badge.svg` or `badge-l0``l4`) | `harness` · `L4` | README row (112×20) |
144143
| **Share card** (`card-l0``l4`) | Full banner with level name | Social posts, repo hero |
145144

146-
**Live badge (recommended)** — updates itself when your level changes:
145+
The pill looks the same whether CI regenerates it or you pin a static file.
146+
147+
**Auto-updating badge (recommended)** — CI writes `harness-badge.svg` on every run:
147148

148149
```yaml
149150
# .github/workflows/harness.yml
@@ -156,13 +157,13 @@ shields.io subscription:
156157
<img alt="Harness Score" src="https://raw.githubusercontent.com/<you>/<repo>/badges/harness-badge.svg" height="20">
157158
```
158159

159-
**Compact badge**pin a level (`l0``l4`); same pill, static file:
160+
**Pinned badge** — same pill, static `badge-lN.svg`:
160161

161162
```md
162163
<img alt="Harness Score L3" src="https://paladini.github.io/harness-score/maturity/badge-l3.svg" height="20">
163164
```
164165

165-
All five compact badges:
166+
All five badge levels:
166167

167168
<p align="center">
168169
<img alt="L0" src="https://paladini.github.io/harness-score/maturity/badge-l0.svg" height="20">

action/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
Runs the deterministic [harness-score](https://paladini.github.io/harness-score/)
44
scanner in CI: reports the repository's AI-harness maturity level, writes a
5-
branded SVG pill (`harness` · `L4` — level only, 112×20), and (optionally)
6-
fails the build below a minimum level so your harness only ratchets up. Because
5+
branded SVG pill (`harness` · `L4`), and (optionally) fails the build below a minimum level so your harness only ratchets up. Because
76
the badge is re-rendered for the detected level on every run, publishing it
87
once gives you a self-updating README badge for free.
98

docs/guide/maturity-model.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ can honestly claim.
115115
effort (L1: write AGENTS.md → L2: rules + hygiene → L3: sensors + CI →
116116
L4: hooks).
117117
3. Gate the level in CI (`--min-level`) so maturity only ratchets up.
118-
4. Show it off — three branded SVGs (live pill, compact pill, share card) in
119-
[Show your maturity](/guide/measure-and-improve#show-your-maturity). Badges
120-
display `harness` + the level only; level names live on the share cards.
118+
4. Show it off — a README badge (`harness` · `L4`) and optional
119+
[share card](/guide/measure-and-improve#show-your-maturity). Same pill from
120+
CI (`--badge`) or a pinned static file.
121121

122122
Chapter 7 walks each step, check by check.

docs/guide/measure-and-improve.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -80,20 +80,22 @@ Or use the packaged action, which also emits the badge:
8080
8181
## Show your maturity {#show-your-maturity}
8282
83-
Harness Score ships **three branded SVG artifacts** in the same visual language
83+
Harness Score ships **two branded SVG formats** in the same visual language
8484
as the scanner's progress bars — no shields.io, no paid service, no network at
8585
render time:
8686
87-
| Artifact | File | Shows | Best for |
87+
| Format | Files | Shows | Best for |
8888
|---|---|---|---|
89-
| **Live badge** | `harness-badge.svg` | `harness` · `L4` | README row — updates when your level changes |
90-
| **Compact badge** | `badge-l0.svg` … `badge-l4.svg` | `harness` · `L3` | Pin a level without the long name |
91-
| **Share card** | `card-l0.svg` … `card-l4.svg` | Full banner with level name | Social posts, repo hero image |
89+
| **Badge** | `harness-badge.svg` or `badge-l0.svg` … `badge-l4.svg` | `harness` · `L4` | README row (112×20 pill) |
90+
| **Share card** | `card-l0.svg` … `card-l4.svg` | Full banner with level name | Social posts, repo hero (860×240) |
9291

93-
Compact and live badges show **only the level** (`L0`–`L4`). Level names
92+
The badge always shows **only the level** (`L0`–`L4`). Level names
9493
(Unharnessed, Guided, …) live on the share cards and in the scanner output.
9594

96-
### Option A — live badge (recommended)
95+
The pill looks identical whether CI regenerates it or you pin a static file —
96+
only the wiring differs.
97+
98+
### Badge — auto-updating (recommended)
9799

98100
`harness-score --badge` writes an SVG for whatever level the scanner detects.
99101
Wire it into CI once; the README image updates itself as your harness improves.
@@ -127,35 +129,36 @@ the same row (112×20 SVG; level only — score percent stays in the CLI report)
127129
<img alt="Harness Score" src="https://paladini.github.io/harness-score/harness-badge.svg" height="20">
128130
```
129131

130-
This guide's site dogfoods the pattern — the live badge below is regenerated
131-
on every Pages deploy:
132+
This guide's site dogfoods the pattern — badge below is regenerated on every
133+
Pages deploy:
132134

133135
<div class="hs-visual">
134-
<p class="hs-visual-label">Live badge</p>
136+
<p class="hs-visual-label">Badge (this repo)</p>
135137
<div class="hs-badge-row">
136138
<img class="hs-badge" src="/harness-badge.svg" alt="Harness Score" height="20">
137139
</div>
138140
</div>
139141

140-
The matching banner card for the detected level is published as
142+
The matching share card for the detected level is published as
141143
`harness-card.svg` (currently L4 for this repository):
142144

143145
<img class="hs-share-card" src="/harness-card.svg" alt="Harness Score L4 · Self-correcting">
144146

145-
### Option B — compact badge (level only)
147+
### Badge — pin a level
146148

147-
Prefer a static pill? Pick the compact badge for your level (`l0`–`l4`):
149+
Same pill, static file — pick `badge-l0.svg` … `badge-l4.svg` if you do not
150+
want CI to regenerate the image:
148151

149152
```md
150153
<img alt="Harness Score L3" src="https://paladini.github.io/harness-score/maturity/badge-l3.svg" height="20">
151154
```
152155

153-
### Option C — share card (full name)
156+
### Share card
154157

155158
For a hero image or social post, use the banner card — it includes the level
156159
name (`Unharnessed`, `Guided`, …):
157160

158-
| Level | Compact badge | Share card |
161+
| Level | Badge | Share card |
159162
|---|---|---|
160163
| L0 · Unharnessed | [badge-l0.svg](https://paladini.github.io/harness-score/maturity/badge-l0.svg) | [card-l0.svg](https://paladini.github.io/harness-score/maturity/card-l0.svg) |
161164
| L1 · Documented | [badge-l1.svg](https://paladini.github.io/harness-score/maturity/badge-l1.svg) | [card-l1.svg](https://paladini.github.io/harness-score/maturity/card-l1.svg) |
@@ -164,7 +167,7 @@ name (`Unharnessed`, `Guided`, …):
164167
| L4 · Self-correcting | [badge-l4.svg](https://paladini.github.io/harness-score/maturity/badge-l4.svg) | [card-l4.svg](https://paladini.github.io/harness-score/maturity/card-l4.svg) |
165168

166169
<div class="hs-visual">
167-
<p class="hs-visual-label">Compact badges (112×20)</p>
170+
<p class="hs-visual-label">All badge levels (112×20)</p>
168171
<div class="hs-badge-row">
169172
<img class="hs-badge" alt="L0" src="/maturity/badge-l0.svg" height="20">
170173
<img class="hs-badge" alt="L1" src="/maturity/badge-l1.svg" height="20">

docs/index.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ features:
3131
details: Five levels, six dimensions, thirty-three deterministic checks. `npx harness-score` — no LLM calls, no network, no telemetry.
3232
- icon: 🏷️
3333
title: Badges you can show off
34-
details: Three branded SVGslive pill (`harness` · `L4`), compact pill per level, and share cards with full names. Wire the scanner into CI once; your README badge updates itself. Free, no shields.io.
34+
details: Two SVG formatsa 20px README pill (`harness` · `L4`) and a share card with the level name. Wire `--badge` into CI for auto-update, or pin a static file. Free, no shields.io.
3535
---
3636

3737
## One command, zero AI
@@ -48,32 +48,24 @@ the **Harness Score** plugin.
4848

4949
## Branded visuals
5050

51-
Three SVG artifacts20px pills for README rows, banner cards for posts.
51+
Two SVG formatssame visual language as the scanner:
5252

5353
<div class="hs-visual">
54-
<p class="hs-visual-label">1 · Live badge</p>
55-
<div class="hs-badge-row">
56-
<img class="hs-badge" alt="Live badge (auto-updates)" src="/harness-badge.svg" height="20">
57-
</div>
58-
<p class="hs-visual-detail">Regenerated on every CI run — <code>harness</code> + detected level.</p>
59-
</div>
60-
61-
<div class="hs-visual">
62-
<p class="hs-visual-label">2 · Compact badges</p>
54+
<p class="hs-visual-label">Badge · 112×20</p>
6355
<div class="hs-badge-row">
6456
<img class="hs-badge" alt="L0" src="/maturity/badge-l0.svg" height="20">
6557
<img class="hs-badge" alt="L1" src="/maturity/badge-l1.svg" height="20">
6658
<img class="hs-badge" alt="L2" src="/maturity/badge-l2.svg" height="20">
6759
<img class="hs-badge" alt="L3" src="/maturity/badge-l3.svg" height="20">
6860
<img class="hs-badge" alt="L4" src="/maturity/badge-l4.svg" height="20">
6961
</div>
70-
<p class="hs-visual-detail">Static files to pin a level — same pill, no auto-update.</p>
62+
<p class="hs-visual-detail">README pill: <code>harness</code> + level. Same look whether CI regenerates it (<code>--badge</code>) or you pin a static <code>badge-lN.svg</code>.</p>
7163
</div>
7264

7365
<div class="hs-visual">
74-
<p class="hs-visual-label">3 · Share card</p>
66+
<p class="hs-visual-label">Share card · 860×240</p>
7567
<img class="hs-share-card" alt="L4 · Self-correcting" src="/maturity/card-l4.svg">
76-
<p class="hs-visual-detail">860×240 banner with the level name for social posts and repo heroes.</p>
68+
<p class="hs-visual-detail">Banner with the level name for social posts and repo heroes.</p>
7769
</div>
7870

7971
Gallery, CI recipes, and embed snippets:

packages/cli/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ TypeScript types.
8282
Or use the [packaged GitHub Action](https://github.com/paladini/harness-score/tree/main/action),
8383
which also emits the badge.
8484
85-
Three branded SVG artifacts (live pill, compact pill per level, share card):
85+
Two branded SVG formats (README badge + share card):
8686
[Show your maturity](https://paladini.github.io/harness-score/guide/measure-and-improve#show-your-maturity).
87-
Badges show `harness` + the level only; level names live on the share cards.
87+
The pill is identical from CI (`--badge`) or a pinned `badge-lN.svg`.
8888

8989
## Cursor plugin
9090

0 commit comments

Comments
 (0)