Skip to content

README: lead with the problem and the business, in plainer words - #115

Merged
shuv-amp merged 2 commits into
mainfrom
docs/readme-business
Oct 17, 2026
Merged

shuv-amp merged 2 commits into
mainfrom
docs/readme-business

Conversation

@Prafyl

@Prafyl Prafyl commented Oct 17, 2026

Copy link
Copy Markdown
Collaborator

Makes the README easier for judges, investors and protocol founders to read, without losing any of the technical detail.

  • Headline numbers under the attack GIF: $285M lost by Drift, 10M → 9.9M kept on devnet, 9 days for half a vault to leave.
  • The problem: the evidence table rewritten as plain one-line facts, with sources below it.
  • Business model (new section): Cloud tiers and prices from docs/11 (labelled as a hypothesis), why protocols pay (attest), and the market size. Replaces the dense "Who pays" paragraph and keeps its caveats.
  • What the checks show: a six-row plain-English summary, with the full table collapsed under it.
  • Guarantees: a plain-English column next to each precise statement.
  • Nav bar gains The problem and Business.

No numbers, ids, hashes or commands changed. Every figure is taken from the current README or docs/11-BUSINESS.md.

Prafyl and others added 2 commits October 17, 2026 21:21
Adds a headline-numbers strip, a plain 'The problem' section, a Business
model section (Cloud tiers, why protocols pay, market size from docs/11),
a plain-English summary of the checks with the full table collapsed, and
a plain-English column for the guarantees. No numbers changed.
Replaces the README with a rewrite that keeps every number and caveat but
leads with proof, and replaces the generated banner and the demo-video GIF
with figures drawn from the repo's own data, light and dark:

- Header: a hull in section, one compartment breached, the bulkhead holding.
- Fig. 1: Drift modeled behind Bulkhead (reference/drift_model.py): half the
  vault in 12 minutes without it, 9 days with it.
- Fig. 2: where Bulkhead sits; replaces the mermaid diagram.
- Fig. 3: scenario S1 as a trace, animated at 4x, drawn from one run of
  cloud/e2e/run.sh on 17 Oct 2026 (times and signatures in s1-run.json).

Also corrects "one every 800 ms": attack.mjs sends each payout 800 ms after
the last one confirmed. docs/assets/src/render.sh rebuilds every figure.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@shuv-amp
shuv-amp merged commit 8570102 into main Oct 17, 2026
11 checks passed
@shuv-amp
shuv-amp deleted the docs/readme-business branch October 17, 2026 17:06
shuv-amp added a commit that referenced this pull request Oct 17, 2026
The README conflict is resolved to main's new layout with this branch's
corrected counts: Kani 17/17 (14 Oct, 14 at full width), 133/133 program
tests, 9 fuzz targets with the note on the unmeasured one, 33 differential
commands, and tools/claims.py in the repository layout. Two rules now accept
the new table rows, whose label is followed by a caption.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
shuv-amp added a commit that referenced this pull request Oct 17, 2026
Conflicts resolved: this branch's counts in docs/09 (136 program tests,
Vault 91), main's tools/claims.py, and main's README with 136/136.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Oct 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants