docs(readme): rewrite both READMEs to be short and accurate - #66
Merged
Merged
Conversation
Lead with what the gateway does for an organization: per-user identity for MCP tool calls, security guards, SSO/RBAC, limits and budgets, cost accounting and the audit trail. Spec-sheet detail already covered by thinkwat.ch/docs is dropped; behaviour the docs do not cover is kept in a compact section. Corrections against the code: - Core dependency is four crates (tw-bedrock added), not three. - Limits attach to users, API keys and roles only; there are no provider, MCP-server or team subjects. - PII placeholders are restored in streamed answers too. - OpenAI streams no longer need stream_options.include_usage from the client; the gateway asks for usage itself. - Weighted tokens come from input_weight/output_weight against the platform baseline price, not input_multiplier/input_price. - The MCP Store ships 36 templates; the Chinese secret-rotation page exists now. Co-Authored-By: Claude Opus 5.5 <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
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.
Summary
Rewrites
README.mdandREADME.zh-CN.md(375 and 243 lines, now 124 each) to lead with what ThinkWatch does for an organization:tw-key for AI and MCPKept: badges, architecture sketch, the exact quick-start commands, deployment options, doc links, license summary with the BSL 1.1 thresholds unchanged, the Core relation, and a one-line pointer to Lite. Spec-sheet material that thinkwat.ch/docs already covers (hardening headers, metrics, health endpoints, tech stack, project tree) is removed. Behaviour the docs do not cover is kept in a short "Behaviour worth knowing" section.
Corrections against the code
tw-bedrockadded), not "exactly three".userandapi_key_lineage(plus role constraints folded into the user); the old provider / MCP-server / team subject table did not matchcrates/common/src/limits/mod.rs.proxy/shaper.rs,FrameRestorer); the old "streaming does not restore" note was stale.stream_options.include_usagefrom the client; the gateway requests usage itself (proxy/generate.rs).input_weight/output_weightagainst the platform baseline price;input_multiplier/input_priceno longer exist.lifecycle_rate_limiter_fail_open_total, notgateway_rate_limiter_fail_open_total(dropped from the README).🤖 Generated with Claude Code