Repository navigation
Shorten the READMEs and add a banner - #6
Merged
Merged
Conversation
Merged
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
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.
Shortens both READMEs and adds the og card as a banner at the top, in the style of openchatter.
README.mdgoes from 195 to 86 lines: banner, what it is, browser use, agent quick start, a short privacy summary, limits, and links out.cli/README.md(the npm page) goes from 518 to 210 lines: the same banner (absolute URL so npm renders it), one short description and example per command, exit codes, protection limits, and MCP setup. Links outside the package use full GitHub URLs so they work on npm.docs/security-model.md(crypto, Durable Objects, analytics, known limits),docs/cli-reference.md(command internals, masking, startup guards, and the single full refused-key list), anddocs/development.md(layout, API, dev commands, releases).docs/agent-tooling.mdonly changes its link to the refused-key list.Docs only, no code changes. 795 tests passed (1 Windows-only skip), typecheck passed, and all 29 links and anchors resolve.
Merge this before publishing 0.5.0 so the npm page gets the new README.
Need help on this PR? Tag
@codesmithwith what you need. Autofix is disabled.