Skip to content

Lead the README with npm install - #5

Merged
guohai merged 1 commit into
mainfrom
docs/npm-first
Sep 11, 2026
Merged

guohai merged 1 commit into
mainfrom
docs/npm-first

Conversation

@guohai

@guohai guohai commented Sep 11, 2026

Copy link
Copy Markdown
Collaborator

Makes npm i -g @agora-build/tcap the default install; the install script
becomes the "without Node" alternative. The npm page already led with npm, so
the two now agree.

Generated with SMT smt@agora.build

`npm i -g @agora-build/tcap` is the default; the install script becomes the
"without Node" alternative rather than the first thing offered. The npm page
already led with it, so the two now agree.

🤖 Built with SMT <smt@agora.build>
@github-actions

Copy link
Copy Markdown

🤖 Codex Code Review

No findings. The README-only change correctly makes npm i -g @agora-build/tcap the primary installation method and accurately labels the standalone script as the alternative for systems without Node. It does not affect capture logic, shell hooks, scrollback coordinates, or handling of terminal contents.

@github-actions

Copy link
Copy Markdown

🤖 Claude Code Review

No issues found.

The change is documentation-only: it swaps the order of the two install methods in README.md:32-42, promoting npm i -g @agora-build/tcap over the curl | bash one-liner and relabelling the second as "Or without Node:".

Checks done:

  • Accuracy — the package name matches npm/package.json:2 and the npm badge at README.md:4.
  • Coverage parity — npm/package.json declares os: [linux, darwin] × cpu: [x64, arm64], the same four targets the tag-driven release builds, so leading with npm doesn't narrow the audience the curl script served. The "Or without Node:" framing correctly names the only real gap (no Node runtime).
  • Consistency — npm/README.md already leads with npm, so the two readmes now agree.

No code, shell hooks, or backend coordinate arithmetic are touched, so none of the scrollback or capture-leak concerns apply to this diff.

@guohai
guohai merged commit fddfd56 into main Sep 11, 2026
5 checks passed
@guohai
guohai deleted the docs/npm-first branch September 11, 2026 08:48
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