-
Notifications
You must be signed in to change notification settings - Fork 635
docs: use pnpm add in README install commands #8592
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: use pnpm add in README install commands #8592
Conversation
|
|
@Olexandr88 is attempting to deploy a commit to the thirdweb Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughREADME.md documentation updated to replace npm package installation commands with pnpm equivalents across multiple library sections (React, Backend, React Native adapter, wagmi-adapter, and Type-safe API wrappers including api, engine, insight, vault-sdk, and nebula). Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Pre-merge checks❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
125-125: Optional: Consider varying sentence structure in API wrapper descriptions.The descriptions for the three Type-safe API wrappers (lines 125, 133, 141) all begin with "TypeScript SDK for," which creates repetitive phrasing. This is a minor readability enhancement opportunity.
🔎 Example refactoring for varied phrasing
You could vary the descriptions slightly while preserving clarity:
#### [`@thirdweb-dev/insight`](./packages/insight/README.md) -TypeScript SDK for Insight, thirdweb's multichain indexer service. +thirdweb's TypeScript SDK for Insight, our multichain indexer service.This maintains parallel structure with the API and Engine sections while improving readability.
Also applies to: 133-133, 141-141
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~133-~133: Ensure spelling is correct
Context: ...ript SDK for Engine, thirdweb's backend onchain executor service. ```bash pnpm add @th...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~140-~140: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...nsight`](./packages/insight/README.md) TypeScript SDK for Insight, thirdweb's multichain ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (1)
README.md (1)
25-25: Excellent! Installation commands are now consistent with the project's pnpm workspace.All ten package installation commands have been correctly updated from
npm installtopnpm add, ensuring developers follow the correct workflow for this repository. The changes are consistent and properly formatted across all sections (Core Package, Quick Start examples, Adapters, and Type-safe API wrappers).Also applies to: 49-49, 73-73, 110-110, 118-118, 128-128, 136-136, 144-144, 152-152, 160-160
Fix incorrect install commands in README.
The repository uses pnpm workspaces, but the README referenced npm install.
PR-Codex overview
This PR updates the installation commands in the
README.mdfile from usingnpmtopnpm, aligning with the preferred package manager for the project.Detailed summary
npm install thirdwebtopnpm add thirdwebfor:@thirdweb-dev/react-native-adaptertopnpm add @thirdweb-dev/react-native-adapter.@thirdweb-dev/wagmi-adaptertopnpm add @thirdweb-dev/wagmi-adapter.@thirdweb-dev/apitopnpm add @thirdweb-dev/api.@thirdweb-dev/enginetopnpm add @thirdweb-dev/engine.@thirdweb-dev/insighttopnpm add @thirdweb-dev/insight.@thirdweb-dev/vault-sdktopnpm add @thirdweb-dev/vault-sdk.@thirdweb-dev/nebulatopnpm add @thirdweb-dev/nebula.Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.