Repository navigation
The README's first screen says what you get, what to run and what holds, before how it works - #86
Merged
Merged
Conversation
…ds, before how it works Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019L84nEW9X9yPK19irfofXu
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Only the top of
README.md, above the first long-form section. The first screen now gives a newcomer three answers in order: the prize, in one line in the reader's words (your app, served from your own machine and paid for every request, with no cloud, no domain and no open port, by an agent that cannot spend more than you allow); the action, as the install line followed by three commands, each with a half-line of what it produces; and the guarantee, as four one-line bullets (the first run is on devnet and free, the agent holds no key that pays and you set, approve and revoke, one install with no root and no account on Linux with KVM, and MIT). A single line then points at the long-form part, which continues as before. The banner, badges, nav links and install command keep the house style. Below the fold nothing changed except the sentences that moved up: the old four-command block, "The first run is on devnet and costs nothing", and the prerequisites sentence of theinstall.shparagraph. The first screen is 143 words excluding the code block and badges. Every fact comes fromREADME.md,docs/guide/first-run.md,docs/guide/concepts.mdandCONTEXT.md.Why
A product designer reviewing the TOON sites and READMEs said they are "hard to understand, mostly because of dense text", and that a user cannot quickly see (1) the prize the product offers them, (2) what they have to do to get it, and (3) the guarantee, the mechanics that make it work. The README was accurate and written in the voice of (3) from the first line. This puts (1), (2) and (3) first, in that order, and leaves the mechanics where they were.
🤖 Generated with Claude Code
https://claude.ai/code/session_019L84nEW9X9yPK19irfofXu