update readme

[yanchuk]

Updating a readme to have a bit the same structure as https://github.com/railsware/mailtrap-php with Prerequisites and Supported functionality sections

Summary by CodeRabbit

• Documentation
  • Expanded and reorganized the README to provide clearer setup instructions, detailed usage examples, and comprehensive feature lists.
  • Added new sections covering prerequisites, supported functionality, and example scripts.
  • Enhanced usage examples, including sending emails, using templates, sandbox testing, and managing contacts.
  • Updated Ruby on Rails integration details and clarified encoding information.
  • Improved formatting and minor syntax corrections for better readability.

[coderabbitai[bot]]

Walkthrough

The README.md file was extensively rewritten and expanded to provide detailed guidance for the Mailtrap Ruby client. New sections, enhanced usage examples, improved formatting, and clarifications were introduced, covering prerequisites, supported features, installation, usage scenarios, API examples, and encoding details. No code or public API changes were made.

Changes

Cohort / File(s)

Change Summary

Documentation Overhaul README.md

Major expansion and restructuring: added license badge, prerequisites, supported functionality, enhanced usage section with multiple new examples, updated Ruby on Rails and pure Ruby examples, extended Email Templates and Contacts API examples, added multiple Mailtrap clients usage, introduced a comprehensive Examples section, moved and expanded encoding explanation, and improved formatting and syntax throughout.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐇
I hopped through README fields anew,
With badges bright and sections true,
Examples sprout, instructions bloom,
For Mailtrap’s Ruby guide, make room!
Now clearer paths for bunnies keen,
To send their mails—so swift, so clean!
📬✨

[!NOTE]

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment
• [ ] Commit unit tests in branch readme-update

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.