docs(readme): registry install and current public API (CL-8775) - #20
Merged
Merged
Conversation
Registry install (npm/pnpm/yarn/bun) is the primary path. Document the current public API. Fixes CL-8775.
Use Quickstart / How it works / Development / License instead of Install / Use / Full example / Contributing.
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 Quickstart to model real host usage instead of an in-process demo.
Three sections, in mount order:
mountArtifacts) — wiring function takesdb,grantStore,conditionRegistry, and optionalcountSegmentsas typed parameters and buildsrequireGrantwith Interchange's owncreateRequireGrant.mountWorkflowArtifacts) — wiring function takesdb,resolveRunScope(WorkflowRunResolver), and optionalagentToken(AgentTokenAuth) as typed parameters; no fake auth implementation.@corbits/artifacts/sidecar-bundle) — shows theartifactstool factory dropped straight intodefineAgent'stools, matching how an agent package consumes this package with no client code of its own.Removed: the in-process demo
requireGrantthat let every caller through, and the demoresolveRunScopethat accepted any bearer as a hardcoded tenant. Every host-owned dependency (db, grant store, condition registry, run resolver, agent token verifier) is now a typed parameter, not a fabricated stand-in.Every code block was pasted into a scratch file and type-checked against this repo's own
tsc(with a temporarypathsmapping to self-resolve@corbits/artifacts); all three compile clean. Scratch files were not committed.