docs: registry-first README for @corbits/memory (CL-8775) - #46
Merged
Merged
Conversation
Document npm/pnpm/yarn/bun install of @corbits/memory. Sidecar-bundle is the agent mount, not the primary install.
Rename headings to Runtime support, Quickstart, How it works, Development, License. Registry install stays in Quickstart; sidecar-bundle stays in How it works.
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
Replace the unpublished git-install README with a registry-first README.
@corbits/memory/sidecar-bundleis documented as the deployed-agent mount, not the primary install.Verification
npm/pnpm/yarn/bunof@corbits/memory(nogit+httpsURL)createMemory+loadMemoryConfig; Full example usescreateFakeDocumentStorefromsrc/index.tsmountWorkflowMemory/@corbits/memory/sidecar-bundle)package.jsonscripts (typecheck,test); Bun >= 1.2.0, Node >= 24 for toolingFixes CL-8775