docs: clarify API key generation link in README#109
Conversation
WalkthroughThe README.md file was updated to revise an inline code comment within the usage example. The token line and overall structure remain unchanged; only the wording of the comment text was modified. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🔇 Additional comments (1)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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 |
This PR updates the README to improve clarity around API key generation.
What changed
Replaced the text
"your API key here https://mailtrap.io/api-tokens
"
with
"You can create your API key here https://mailtrap.io/api-tokens
".
Why
The previous phrasing could be misunderstood as suggesting that the key itself should be inserted into code.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.