docs(connector-sdk): write a real README for the npm page#92
Merged
Conversation
The published 0.1.0 README was a stub pointing at a doc in the repo, which looks empty on npmjs.com. Replace with an actual authoring guide: minimal 3-file connector example (package.json + src/index.ts + tsconfig.json), the Connector interface, CapturedItem shape, capability table, prerequisites manifest, helper APIs, and links to first-party + community examples. Bump to 0.1.1 to republish with the expanded README. No code changes; existing consumers (peerDep ^0.1.0) unaffected. Co-Authored-By: Claude Opus 4.6 (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.
Summary
The 0.1.0 README on npm was a 2-line stub pointing at a doc in the Spool repo, which looks unhelpful to anyone landing on the npm package page. Replace with a full authoring guide so a community author can ship their first connector just from reading the npm page.
Contents of the new README
Connectorinterface and two real methods (checkAuth,fetchPage)CapturedItemshape, field-by-fieldSyncError,parseCliJsonOutput,abortableSleep)Versioning
Bumps
@spool-lab/connector-sdkto 0.1.1. Pure docs change; peerDep^0.1.0in all consumer packages still satisfies. Will republish after merge.🤖 Generated with Claude Code