Skip to content

Conversation

@Olexandr88
Copy link
Contributor

@Olexandr88 Olexandr88 commented Dec 29, 2025

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.md file from using npm to pnpm, aligning with the preferred package manager for the project.

Detailed summary

  • Changed installation command from npm install thirdweb to pnpm add thirdweb for:
    • React Applications
    • Backend Applications
  • Updated installation command for @thirdweb-dev/react-native-adapter to pnpm add @thirdweb-dev/react-native-adapter.
  • Updated installation command for @thirdweb-dev/wagmi-adapter to pnpm add @thirdweb-dev/wagmi-adapter.
  • Updated installation command for @thirdweb-dev/api to pnpm add @thirdweb-dev/api.
  • Updated installation command for @thirdweb-dev/engine to pnpm add @thirdweb-dev/engine.
  • Updated installation command for @thirdweb-dev/insight to pnpm add @thirdweb-dev/insight.
  • Updated installation command for @thirdweb-dev/vault-sdk to pnpm add @thirdweb-dev/vault-sdk.
  • Updated installation command for @thirdweb-dev/nebula to pnpm add @thirdweb-dev/nebula.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions across multiple package documentation sections to ensure consistent and current setup guidance for all components.

✏️ Tip: You can customize this high-level summary in your review settings.

@changeset-bot
Copy link

changeset-bot bot commented Dec 29, 2025

⚠️ No Changeset found

Latest commit: 1172dc8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Dec 29, 2025

@Olexandr88 is attempting to deploy a commit to the thirdweb Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 29, 2025

Walkthrough

README.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

Cohort / File(s) Summary
Documentation updates
README.md
Replaced npm install thirdweb with pnpm add thirdweb in installation command snippets and references across main package, React, Backend, React Native adapter, wagmi-adapter, and Type-safe API wrappers sections

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Pre-merge checks

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The description explains the reason for changes and lists all updated packages, but does not follow the repository's template structure with required sections like issue tag or testing instructions. Consider following the template format by adding issue tag (TEAM-0000), Notes for reviewer section, and How to test section for consistency with repository standards.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: updating README install commands from npm to pnpm, which aligns with the file changes and PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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.

📥 Commits

Reviewing files that changed from the base of the PR and between ec73f1f and 1172dc8.

📒 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 install to pnpm 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

@Olexandr88 Olexandr88 closed this Dec 29, 2025
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