Skip to content

docs(npm): lead with npx in README usage section#222

Closed
tkrugg wants to merge 1 commit into
mainfrom
docs/npm-readme-npx-first
Closed

docs(npm): lead with npx in README usage section#222
tkrugg wants to merge 1 commit into
mainfrom
docs/npm-readme-npx-first

Conversation

@tkrugg
Copy link
Copy Markdown
Collaborator

@tkrugg tkrugg commented May 19, 2026

Summary

  • Reorganize npm/algolia/README.md so npx @algolia/cli is the primary install path, with npm install -g shown as a fallback.
  • Split command snippets into a dedicated ## Examples section.

Test plan

  • Render the README on npm after the next publish and confirm npx is the first thing readers see.

🤖 Generated with Claude Code

Reorganize the npm package README so `npx @algolia/cli` is the
primary install path, with `npm install -g` shown as a fallback.
Split command snippets into a separate Examples section.
@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes.

@tkrugg
Copy link
Copy Markdown
Collaborator Author

tkrugg commented May 19, 2026

Wrong README — meant to edit the repo root README, not the npm package one.

@tkrugg tkrugg closed this May 19, 2026
@tkrugg tkrugg deleted the docs/npm-readme-npx-first branch May 19, 2026 20:51
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