Skip to content

Update README.md #707

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.

Sign up for GitHub

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

Open
rehannadaf2 wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

Update README.md #707

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,3 +142,9 @@ If you have any feedback, please reach out to us at support@thirdweb.com.
## License

[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)

# Forge projects
forge install https://github.com/thirdweb-dev/contracts

# Hardhat / npm based projects
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Use hyphenated compound adjective in heading text.

Use npm-based instead of npm based for consistency and grammar.

Suggested diff 
-# Hardhat / npm based projects
+# Hardhat / npm-based projects
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# Hardhat / npm based projects
# Hardhat / npm-based projects
🧰 Tools
🪛 LanguageTool

[grammar] ~149-~149: Use a hyphen to join words.
Context: .../thirdweb-dev/contracts # Hardhat / npm based projects npm i @thirdweb-dev/contr...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 149, Update the README heading "Hardhat / npm based
projects" to use a hyphenated compound adjective by changing it to "Hardhat /
npm-based projects" so the heading reads correctly; locate the heading text in
the README and replace "npm based" with "npm-based".

npm i @thirdweb-dev/contracts
Comment on lines +145 to +150
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Remove duplicated installation block from the License section.

These commands are already documented under ## Installation (Line 16-24). Keeping a second copy under ## License makes the README harder to maintain and easy to drift over time. Consider deleting this block here and keeping installation instructions in one place only.

Suggested diff 
 ## License
 
 [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)
-
-# Forge projects
-forge install https://github.com/thirdweb-dev/contracts
-
-# Hardhat / npm based projects
-npm i `@thirdweb-dev/contracts`
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# Forge projects
forge install https://github.com/thirdweb-dev/contracts
# Hardhat / npm based projects
npm i @thirdweb-dev/contracts
## License
[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)
🧰 Tools
🪛 LanguageTool

[grammar] ~149-~149: Use a hyphen to join words.
Context: .../thirdweb-dev/contracts # Hardhat / npm based projects npm i @thirdweb-dev/contr...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 145 - 150, Remove the duplicated installation block
under the License section by deleting the "Forge projects" and "Hardhat / npm
based projects" commands (the two lines starting with "forge install
https://github.com/thirdweb-dev/contracts" and "npm i `@thirdweb-dev/contracts`"),
leaving the canonical installation instructions that already exist under the "##
Installation" section (the block around lines 16-24); ensure no other duplicate
install snippets remain in the README so installation is documented in one place
only.