Skip to content

docs: add npm badges and stable quick start - #15

Merged
abruption merged 2 commits into
mainfrom
docs/14-readme-npm
Sep 27, 2026
Merged

abruption merged 2 commits into
mainfrom
docs/14-readme-npm

Conversation

@abruption

@abruption abruption commented Sep 27, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Add npm version, weekly/monthly downloads, CI, supported Node and MIT badges to all four README languages, using the Python session-peer and agy-cli-usage introductions as references.
  • Put the verified public session-peer@0.1.0 install and a safe first list/--dry-run example near the top of the English README. Keep the source tarball path and Python CLI PATH coexistence guidance separate.
  • Update the translated install/release text so it no longer describes 0.1.0 as unpublished. Keep the TypeScript feature boundary explicit; no Python demo or optional Python features are claimed here.

Validation

  • node scripts/check-repository.mjs and git diff --check passed.
  • npm version, CI, Node and license badge SVG endpoints returned HTTP 200 with the expected labels.
  • Both download badge endpoints returned HTTP 200 SVGs, but currently display "package not found or too new": npm's downloads API still returns 404 for this newly published package. The README notes that counts will appear after npm statistics index it. No count is invented.
  • PR CI run 36316163806 passed on attempt 2 for the final SHA. Attempt 1 hit the existing intermittent Windows Node 22 session-discovery timeout (about eight seconds); the same SHA passed on rerun.
  • Documentation only; no runtime, publication workflow, npm tag, or dependency change.

Closes #14.

@abruption
abruption merged commit 2e8d111 into main Sep 27, 2026
15 of 17 checks passed
@abruption
abruption deleted the docs/14-readme-npm branch September 27, 2026 23:30
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.

docs: add npm badges and stable quick start to README

1 participant