Skip to content

Commit 6dbb4a0

Browse files
fedorovvvvclaude
andcommitted
docs(readme): refresh stale dogfood metrics + bundle size claims
Sweep stale numbers to match post-PRD-030 / post-PR-125 reality: - "~1.8 MB single-file bundle" → "~1.4 MB" (matches `[build] dist/ ready (1.40M)` after #125 drops precompressed siblings). - Dogfood card row reframed: · drop "~200 LOC" (entry shim is now 5 lines after ADR-003 split, real work spans ~1.3K across `bin/{cli,commands,lib}/*`) · drop "0 runtime deps" (ADR-003 amended to a named-allowlist — `citty` is the one allowed runtime dep, with 0 transitives) · drop "~6 MB tarball with bundled node_modules" (PRD-030 graduated the legacy SvelteKit-with-`node_modules/` shape; current local pack is ~870 kB / ~3 MB unpacked) · lead with what users actually care about (per-image size + tarball weight) instead of LOC bragging - "(~11 artifacts)" in `npm run dev` comment → "100+" (avoids drift; current `forgeplan health` reports 99 artifacts on develop). Mirrors apply to both README.md and README.ru.md. Refs: PRD-030, PR #125, ADR-003. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent f37817a commit 6dbb4a0

2 files changed

Lines changed: 20 additions & 18 deletions

File tree

‎README.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ npx @forgeplan/web init -y --image nightly # pre-release track
106106
```
107107

108108
Every release ships two named **images** of the scaffold. The bytes are
109-
the same self-contained ~1.8 MB single-file bundle (no `node_modules/`,
109+
the same self-contained ~1.4 MB single-file bundle (no `node_modules/`,
110110
no `npm install` at user side); the difference is the feature-flag set
111111
each image carries. v1 ships both images with **zero** flags — the
112112
framework is in place for opt-in features without users-of-stable
@@ -158,7 +158,7 @@ appear in seconds (after `forgeplan reindex`).
158158

159159
| | |
160160
| :-------------------------- | :-------------------------------------------------------------------------------------------------------------------- |
161-
| **📦 Zero install at user** | The package ships one self-contained ~1.8 MB single-file bundle per declared image (`dist/` for `stable`, `dist-nightly/` for `nightly`). `init` is a `cp -r` — no `npm install` runs at user side. |
161+
| **📦 Zero install at user** | The package ships one self-contained ~1.4 MB single-file bundle per declared image (`dist/` for `stable`, `dist-nightly/` for `nightly`). `init` is a `cp -r` — no `npm install` runs at user side. |
162162
| **🪟 Truly cross-platform** | Smoke matrix on `ubuntu-latest` / `macos-latest` / `windows-latest` × Node 22, green on every push since v0.1.3. |
163163
| **🔒 Read-only by design** | `/api/*` proxy invokes only read-only `forgeplan` subcommands (rule 22). The viewer **cannot mutate** your workspace. |
164164
| **🌐 Five graph views** | Force, Lanes, Matrix, Radial, Tree. Each picks a different question — flow, adjacency, hierarchy, parent/child. |
@@ -193,15 +193,16 @@ Three entry points — pick the one that matches what you need now.
193193

194194
<table>
195195
<tr>
196-
<td align="center"><b>~200</b><br>LOC in the bin script</td>
197-
<td align="center"><b>3</b><br>OS verified in CI</td>
198-
<td align="center"><b>0</b><br>runtime deps in <code>bin/</code></td>
199-
<td align="center"><b>~6 MB</b><br>tarball with bundled <code>node_modules</code></td>
196+
<td align="center"><b>~1.4 MB</b><br>per image (esbuild bundle)</td>
197+
<td align="center"><b>~870 kB</b><br>packed tarball (~3 MB unpacked)</td>
198+
<td align="center"><b>3 OS × Node 22</b><br>green smoke matrix</td>
199+
<td align="center"><b>1 dep</b><br>in <code>bin/</code> (<code>citty</code>, 0 transitive)</td>
200200
</tr>
201201
</table>
202202

203203
This repository follows its own methodology — every PRD, RFC, ADR and
204-
EvidencePack lives in [`.forgeplan/`](./.forgeplan/), validated and scored
204+
EvidencePack lives in [`.forgeplan/`](./.forgeplan/) (100+ artifacts at
205+
HEAD, browsable in the same UI this package ships). Validated and scored
205206
locally; nothing ships to `main` without `R_eff > 0`, an active artifact,
206207
and a green smoke matrix.
207208

@@ -224,7 +225,7 @@ rejected with `GH006` / `GH013`. Full guide — [`CLAUDE.md`](CLAUDE.md).
224225
### Local dev modes
225226

226227
```bash
227-
npm run dev # HMR against this repo's own .forgeplan/ (~11 artifacts)
228+
npm run dev # HMR against this repo's own .forgeplan/ (100+ artifacts)
228229
npm run dev:playground # HMR against playground/.forgeplan/ (~123 seeded Helios artifacts)
229230
```
230231

‎README.ru.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ npx @forgeplan/web init -y --image nightly # pre-release ветка
106106
```
107107

108108
Каждый релиз шипит два именованных **образа** (image) скаффолда. Байты
109-
у обоих одинаковые — self-contained ~1.8 MB single-file bundle (без
109+
у обоих одинаковые — self-contained ~1.4 MB single-file bundle (без
110110
`node_modules/`, никакого `npm install` на стороне пользователя);
111111
разница в наборе фичефлагов, которые несёт каждый образ. v1 шипит оба
112112
образа с **нулём** флагов — фреймворк готов к опт-ин фичам без того
@@ -158,7 +158,7 @@ kind, status, диапазону `R_eff`; кликни узел — увидиш
158158

159159
| | |
160160
| :---------------------------------- | :--------------------------------------------------------------------------------------------------------------- |
161-
| **📦 Без установок у пользователя** | Пакет содержит один self-contained ~1.8 MB single-file bundle на каждый объявленный образ (`dist/` для `stable`, `dist-nightly/` для `nightly`). `init` — это `cp -r`. У пользователя ничего не ставится. |
161+
| **📦 Без установок у пользователя** | Пакет содержит один self-contained ~1.4 MB single-file bundle на каждый объявленный образ (`dist/` для `stable`, `dist-nightly/` для `nightly`). `init` — это `cp -r`. У пользователя ничего не ставится. |
162162
| **🪟 По-настоящему cross-platform** | Smoke-матрица `ubuntu-latest` / `macos-latest` / `windows-latest` × Node 22, зелёная на каждом push с v0.1.3. |
163163
| **🔒 Read-only by design** | `/api/*` дёргает только read-only подкоманды `forgeplan` (правило 22). Вьювер **не может** изменить воркспейс. |
164164
| **🌐 Пять видов графа** | Force, Lanes, Matrix, Radial, Tree. Каждый отвечает на свой вопрос — поток, смежность, иерархия, parent/child. |
@@ -193,17 +193,18 @@ kind, status, диапазону `R_eff`; кликни узел — увидиш
193193

194194
<table>
195195
<tr>
196-
<td align="center"><b>~200</b><br>строк в bin-скрипте</td>
197-
<td align="center"><b>3</b><br>OS в CI</td>
198-
<td align="center"><b>0</b><br>runtime-зависимостей в <code>bin/</code></td>
199-
<td align="center"><b>~6 МБ</b><br>tarball вместе с <code>node_modules</code></td>
196+
<td align="center"><b>~1.4 МБ</b><br>на образ (esbuild-бандл)</td>
197+
<td align="center"><b>~870 КБ</b><br>tarball (~3 МБ распакованный)</td>
198+
<td align="center"><b>3 OS × Node 22</b><br>зелёная smoke-матрица</td>
199+
<td align="center"><b>1 dep</b><br>в <code>bin/</code> (<code>citty</code>, 0 транзитивных)</td>
200200
</tr>
201201
</table>
202202

203203
Этот репозиторий использует свою же методологию — каждый PRD, RFC, ADR и
204-
EvidencePack лежит в [`.forgeplan/`](./.forgeplan/), локально валидируется
205-
и скорится; ничего не уходит в `main` без `R_eff > 0`, активного артефакта
206-
и зелёной smoke-матрицы.
204+
EvidencePack лежит в [`.forgeplan/`](./.forgeplan/) (на HEAD — 100+
205+
артефактов, листать можно в этом же UI, который пакет шипит). Локально
206+
валидируется и скорится; ничего не уходит в `main` без `R_eff > 0`,
207+
активного артефакта и зелёной smoke-матрицы.
207208

208209
## Contributing
209210

@@ -224,7 +225,7 @@ Branch protection защищает правила на сервере — пря
224225
### Локальные dev-режимы
225226

226227
```bash
227-
npm run dev # HMR против собственного .forgeplan/ репо (~11 артефактов)
228+
npm run dev # HMR против собственного .forgeplan/ репо (100+ артефактов)
228229
npm run dev:playground # HMR против playground/.forgeplan/ (~123 засеянных Helios-артефакта)
229230
```
230231

0 commit comments

Comments
 (0)