Update README.md to enhance installation and usage instructions, impr…

[narekhovhannisyan]

Update readme to enhance installation and usage instructions, impr…ove clarity on API features, and add examples for email sending and contact management functionalities.

Motivation

Changes

• Change 1
• Change 2

How to test

• Test 1
• Test 2

Summary by CodeRabbit

• Documentation
  • Reorganized README into a consolidated "Supported functionality & Examples" section with clearer, categorized example references
  • Standardized example API parameter names to snake_case and updated Nodemailer-related notes
  • Improved Installation with explicit npm/yarn commands and dual-option formatting
  • Expanded Usage with ES modules/CommonJS guidance, explicit initialization, sandbox vs production switching, and bulk/stream recommendations
  • Added richer minimal and full-featured examples for attachments, headers, templates, and transport/dev dependency notes

[coderabbitai]

Warning

Rate limit exceeded

@narekhovhannisyan has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 56 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between 9bc80a3 and b1d444f.

📒 Files selected for processing (1)

• README.md (2 hunks)

Walkthrough

README.md was reorganized and expanded: installation and usage were rewritten (ESM/CommonJS guidance, sandbox vs production), examples were restructured and linked, API example parameters were normalized from camelCase to snake_case, and multiple concrete examples (minimal, bulk, template, attachments, Nodemailer) were added.

Changes

Cohort / File(s)

Summary

Documentation rework README.md

Completely reorganized and expanded README: merged/renamed "Supported functionality" into "Supported functionality & Examples" with categorized subsections and explicit example file references; standardized example parameter names from camelCase → snake_case (e.g., customVariables → custom_variables, templateUuid → template_uuid); rewritten Installation (npm/yarn commands) and Usage (ESM/CommonJS guidance, explicit token initialization, sandbox vs production patterns), added many usage examples (minimal transactional, full-featured, template-based, bulk stream, attachments, headers) and updated Nodemailer transport notes and commands.

Sequence Diagram(s)

(omitted — changes are documentation-only and do not modify control flow)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

• Verify snake_case example parameters match the library's public API.
• Validate example snippets for correct imports, token/env usage, sandbox bootstrap logic.
• Confirm referenced example paths (e.g., examples/sending/minimal.ts, examples/bulk/send-mail.ts) exist and link correctly.

Possibly related issues

• Readme Update mailtrap-java#44 — Similar README reorganization and documentation updates; may be related to coordinating doc structure and example alignment across SDKs.

Suggested reviewers

• VladimirTaytor
• mklocek

Poem

🐰 I hopped through README fields tonight,
I nudged the hump to make it right.
Examples nested, commands in view,
snake_case trails where camels flew.
npm, yarn — a carrot for you! 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description lacks substantive content; Motivation is empty, Changes section only lists placeholders ('Change 1', 'Change 2'), and How to test contains only generic checklist items ('Test 1', 'Test 2').	Replace placeholder text with specific details: list actual changes made (e.g., reorganized sections, added examples, converted to snake_case), explain motivation, and provide concrete testing instructions.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change of updating the README with enhanced installation and usage instructions, which aligns with the comprehensive documentation improvements shown in the changeset.
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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6bd88de and 523d485.

📒 Files selected for processing (1)

• README.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

59-59: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (3)

README.md (3)

18-92: Excellent restructuring of installation and usage sections.

The expanded installation guidance (npm + yarn options), clear ES module/CommonJS note, minimal example, sandbox vs production switching guide with environment variables, and full-featured usage example significantly improve the developer experience. The additions make the documentation more prescriptive and actionable.

---

128-194: Well-executed API parameter standardization to snake_case.

The full-featured example consistently uses snake_case for API parameters (custom_variables, template_uuid, template_variables, content_id, reply_to), which aligns with the documented standardization mentioned in the PR and provides users with copy-paste-ready code that matches the actual SDK API.

---

225-289: All 26 example file paths verified and exist in the repository.

The corrected verification confirms that all linked example files across the "Supported functionality & Examples" section are properly referenced and present in the codebase. No broken links or missing files were found.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 596db0b and 9bc80a3.

📒 Files selected for processing (1)

• README.md (2 hunks)

🔇 Additional comments (5)

README.md (5)

18-25: Installation section is well-structured.

The npm and yarn installation commands are clearly formatted with proper language specifiers and dual options. No concerns.

---

29-107: Usage section is comprehensive and well-structured.

The new "Minimal usage" and "Sandbox vs Production" sections provide excellent guidance with:

• Clear ES module imports
• Environment-based configuration
• Bootstrap logic for switching between sandbox/production
• Best practice recommendations
• Proper snake_case parameter naming throughout

All code examples are properly formatted with language specifiers. No concerns.

---

108-197: Full-featured usage example demonstrates advanced capabilities effectively.

The example covers multiple features (attachments, headers, template usage with nested variables, custom fields) in a realistic way. Parameter naming is consistent with snake_case convention throughout. Code is well-formatted and easy to follow.

---

199-224: Nodemailer Transport section is well-formatted and clear.

Installation instructions for both runtime and development dependencies are properly documented with npm/yarn options and language specifiers. Parameter naming guidance is updated appropriately.

---

225-289: Supported functionality & Examples section is comprehensive and well-organized.

The reorganization into categories (Email API, Sandbox, Contact management, General API) significantly improves discoverability. All example file links follow a consistent pattern and are properly cross-referenced. The section professionally presents all supported functionality without informal placeholders.

Note: Past review comments regarding MD040 (missing bash language specifier) and the informal "(no example yet)" comment have been successfully addressed.