docs(readme): Interchange-style install and examples (CL-8775) - #3
Merged
Merged
Conversation
Registry add commands for @corbits/x-tools. Examples match public exports.
Use Quickstart / How it works / Development / License instead of Install / Use / Full example / Contributing.
Side-effect import only. Drop the package.json example; it is not a public export.
TheGreatAxios
force-pushed
the
cl-8775-readme-x-tools
branch
from
September 22, 2026 04:12
4777d87 to
659c473
Compare
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.
Summary
mainis genuinely a scaffold —index.tsisconsole.log("Hello via Bun!"), no tool exports exist yet (PR #1 has real tools but is unmerged; this README documentsmainonly, per CL-8775). The prior README pass was already honest about that (no fake tool-mount example invented). Only fix: it claimed "Product intent is inPRODUCT.md", but noPRODUCT.mdexists in this repo — removed that false pointer.Checked
workbenchandgtm-workbenchfor a production consumer of@corbits/x-tools; neither imports it (only an unrelated@corbits/xai-providermatched onx). No Quickstart wiring is shown because there is nothing shipped yet to wire.Verification
README-only.
bun install,bun run typecheck, andbun run test(both Development-section commands) run clean against this branch.