docs: fix README accuracy gaps, add missing LICENSE#84
Merged
Conversation
- Quick Start/Install now lead with source (clone+build+link) since npm currently only publishes @smallchat/core@0.1.0 — missing setup, doctor, memex, rtk, and most of what the README documents. npm install is kept as a secondary path with an explicit version note. - Packages table now flags which workspace packages aren't published at all (react, nextjs, testing, playground, vscode). - What's New previously mis-attributed the Semantic map feature to 0.4.0; it actually shipped in the Unreleased section of CHANGELOG.md. Restructured into Unreleased/0.5.0/0.4.0 tiers and surfaced the unreleased security hardening and perf work that wasn't mentioned anywhere in the README. - Added LICENSE (MIT) to match the license already declared in package.json and referenced by the README.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
2 participants
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
Reviewed the README against the actual repo state (CHANGELOG, package.json, CLI source, npm registry) before polishing it. Found two real accuracy gaps and fixed both:
@smallchat/coreis only published at0.1.0on npm (verified against the registry), missingsetup,doctor,memex,rtk, and most of what the README walks through. The satellite packages (react,nextjs,testing,playground,vscode) aren't published at all. Quick Start and Install now lead with build-from-source (clone →npm install && npm run build→npm link), with npm install kept as a clearly-labeled secondary path. The Packages table now shows publish status per package.CHANGELOG.mdit actually shipped in the[Unreleased]section (after 0.5.0). Restructured the section into Unreleased / 0.5.0 / 0.4.0 tiers, and surfaced the unreleased security hardening (CORS default, body-size limits, env allowlisting, prototype-pollution/path-traversal guards, playground XSS fix) and perf work that wasn't mentioned in the README at all.LICENSE(MIT) —package.jsonand the README both declare MIT, but no LICENSE file existed in the repo.Everything else in the README (CLI command table, doc links, ecosystem references) was checked against source and found accurate, so left as-is.
Test plan
src/cli/index.tsregistrations exactlyARCHITECTURE.md,QUICKSTART.md,MIGRATION.md,docs/REFERENCE.md,docs/ecosystem/*, LoomMCP integration page) exist@smallchat/coreand all satellite packages viaregistry.npmjs.orgbin/buildscript wiring inpackage.jsonsupports the new source-build Quick Start[Unreleased]/0.5.0/0.4.0 sections against the new What's New structureGenerated by Claude Code