Update README.md - #185
Conversation
|
Warning Rate limit exceeded@IAmKio has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 50 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThe README.md file was completely rewritten and expanded. The new version provides a comprehensive, framework-agnostic guide to TransactionKit, including installation, usage, API documentation, configuration, and community resources. The package version was also updated from 2.0.0 to 2.0.1. No changes were made to code or exported entities; only documentation and version metadata were updated. Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Yooo! You forgot to bump the version in package.json! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
README.md (4)
31-40: Add peer-dependency installation hintsThe quick-start snippet relies on
viemandviem/accounts, yet the installation section only shows@etherspot/transaction-kit.## 📦 Installation ... # Using npm npm install @etherspot/transaction-kit +# Peer deps (needed for the examples below) +npm install viem viem/accountsDocumenting the peer deps prevents “module not found” surprises for new users.
54-60: Clarify runtime context & avoidwindow.ethereum!non-null assertionThe snippet mixes browser-specific globals (
window.ethereum) with a private-key wallet, which is more typical of Node scripts. Consider:
- Explaining that this example targets the browser and requires an injected wallet (e.g. MetaMask).
- Removing the non-null assertion or guarding against its absence to prevent runtime errors:
- transport: custom(window.ethereum!), + transport: typeof window !== 'undefined' && window.ethereum + ? custom(window.ethereum) + : /* fallback transport here */,Explicitly stating the expected environment keeps the example copy-paste-safe.
55-55: Discourage hard-coding private keys in documentationEven in examples, hard-coding a raw private key encourages bad security practices. Recommend showing environment-variable usage instead:
-const account = privateKeyToAccount('0x...your-private-key...'); +const account = privateKeyToAccount(process.env.PRIVATE_KEY as `0x${string}`);This small change nudges readers toward safer habits.
227-229: Resolve markdown-lint issue MD036 (emphasis as heading)Using emphasis for “Made with ❤️ …” and the closing line violates markdown-lint MD036 and slightly hurts accessibility. Convert them to plain text or proper headings:
-**Made with ❤️ by the Etherspot team** - -_Now go forth and build amazing things! The blockchain is your oyster! 🦪_ +### Made with ❤️ by the Etherspot team + +Now go forth and build amazing things — the blockchain is your oyster! 🦪Also trims excessive exclamation marks flagged by LanguageTool.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~229-~229: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...herspot team** _Now go forth and build amazing things! The blockchain is your oyster! ...
(AWESOME)
[style] ~229-~229: Using many exclamation marks might seem excessive (in this case: 9 exclamation marks for a text that’s 2917 characters long)
Context: ...ng things! The blockchain is your oyster! 🦪_
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.17.2)
README.md
227-227: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
229-229: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
| - `getWalletAddress()` - Get your wallet address | ||
| - `getState()` - Get current kit state | ||
| - `setDebugMode()` - Enable/disable debug logging | ||
| - `reset()` - Clear all transactions and batches |
There was a problem hiding this comment.
a few methods missing:
- getProvider()
- getSdk()
- remove()
- update()
2 participants
Description
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Summary by CodeRabbit