Skip to content

Correct published package installation instructions - #2

Merged
dKosarevsky merged 1 commit into
mainfrom
codex/published-install-docs
Oct 9, 2026
Merged

dKosarevsky merged 1 commit into
mainfrom
codex/published-install-docs

Conversation

@dKosarevsky

Copy link
Copy Markdown
Contributor

Why

The usage guide still said StreamSplit was not published, contradicting the README and the existing npm 0.1.0 release. npm's current 0.1.0 README also retains its pre-publication text; that registry copy needs a separately approved future release.

Changes

  • Give the published npm install --save-dev @agent-axiom/streamsplit command in both guides.
  • Clarify that checkout examples and example:* scripts are not included in the npm archive.
  • Preserve local-tarball instructions specifically for unreleased changes.
  • Add a documentation regression check.

Verification

npm run check passed locally: 53 tests, TypeScript checks, packed ESM/TypeScript consumers, zero runtime dependencies. npm run demo and git diff --check passed. Exact-commit CI will check Node 20/22/24 and eventsource-parser 4.1.1.

No API, package version, publishing access, or release changes. This PR has not been merged or published.

@dKosarevsky
dKosarevsky marked this pull request as ready for review October 9, 2026 00:01
@dKosarevsky
dKosarevsky merged commit f290214 into main Oct 9, 2026
4 checks passed
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