Skip to content

docs: registry-first README for @corbits/embedding (CL-8775) - #4

Merged
TheGreatAxios merged 4 commits into
mainfrom
cl-8775-readme-embedding
Sep 22, 2026
Merged

TheGreatAxios merged 4 commits into
mainfrom
cl-8775-readme-embedding

Conversation

@TheGreatAxios

Copy link
Copy Markdown
Contributor

Summary

Replace the git-install README with a registry-first README: Install, Use, Full example, How it works, Contributing.

Verification

  • Install is npm / pnpm / yarn / bun of @corbits/embedding (no github: URL)
  • Use and Full example call embedTexts / probeEmbedDims from src/index.ts
  • Contributing commands match package.json scripts (build, test, typecheck); Node >= 24 / Bun >= 1.2.0

Fixes CL-8775

Replace the git-install README with the Interchange section shape:
Install / Use / Full example / How it works / Contributing.
Use Quickstart / How it works / Development / License instead of
Install / Use / Full example / Contributing.
@TheGreatAxios
TheGreatAxios merged commit 219239d into main Sep 22, 2026
1 check passed
@TheGreatAxios
TheGreatAxios deleted the cl-8775-readme-embedding branch September 22, 2026 02:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant