docs: rewrite README for V1#40
Merged
Merged
Conversation
Update the README to match the implemented V1 surface and correct two inaccuracies against the code: - Secret injection: describe connection-level injection only (env var for stdio, request header for HTTP). Argument-level injection and schema stripping are deferred (ADR-0012) and are not implemented; move them to a Not-in-scope section rather than presenting them as current behaviour. - Status: replace the "early development / roadmap" framing with an honest status and a Scope / Not-in-scope section reflecting the implemented V1. Add Security model, Observability (the metrics actually registered), and Development-and-checks sections; expand the project layout; add ci/codeql status badges. Every claim is backed by source, config, or an ADR. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Rewrites the README to match the implemented V1 surface and to correct two inaccuracies against the code.
Corrections
internal/secretsis doc-only). The README now describes connection-level injection only — a credential is read from an env var and applied to the stdio subprocess environment or as an HTTP header — and lists argument-level injection under Not in scope.Additions
internal/metrics), and Development-and-checks sections.ci/codeqlstatus badges pointing at the real workflows.Verification
cmd/portcullis/main.goand theMakefile; the mermaid diagram is preserved.Only
README.mdis touched.🤖 Generated with Claude Code