Skip to content

Improve readme #20

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

Merged
merged 2 commits into from
Nov 18, 2025
Merged

Improve readme #20

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c04486
Improve readme
ahmedmawiri Nov 18, 2025
51928cc
grammar
ahmedmawiri Nov 18, 2025
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
22 changes: 15 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,31 @@
[![MongoDB](https://img.shields.io/badge/MongoDB-4EA94B?logo=mongodb&logoColor=white)](https://www.mongodb.com/)
[![npm](https://img.shields.io/npm/v/@sendook/node.svg)](https://www.npmjs.com/package/@sendook/node)

## What is this?
## What is Sendook?

The easiest way to start sending AND **receiving** emails at scale.
Sendook (Arabic for "box" - صندوق) is the easiest way to start sending AND **receiving** emails at scale.

## Why this?
## Why Sendook?

- Setting up email sending at scale is still cumbersome—we had to do it at <a href="https://www.rupt.dev" target="_blank">Rupt</a>
- The ability to configure and check custom domains is still harder than it should be
- We use this extensively at <a href="https://www.rupt.dev" target="_blank">Rupt</a> to have our internal agents handle inbound emails, payments, prioritizations, etc.

## Quick Start

### Using the API
- [Using the API Endpoints](#using-the-api-endpoints)
- [Using the TypeScript SDK](#using-the-typescript-sdk)
- [Self-hosting & Running Locally](#self-hosting--running-locally)
- [Repository Structure](#repository-structure)
- [Features](#features)
- [SDKs](#sdks)
- [License](#license)

### Quick Start
Comment on lines 22 to +32
Copy link

@coderabbitai coderabbitai bot Nov 18, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Remove duplicate "Quick Start" heading to clarify structure.

Line 22 defines ## Quick Start, but line 32 redefines it as ### Quick Start. This creates a confusing heading hierarchy. The subsection heading at line 32 should be removed since the table of contents below it already serves as a guide to the Quick Start sections.

Apply this diff to remove the redundant heading:

 ## Quick Start

 - [Using the API Endpoints](#using-the-api-endpoints)
 - [Using the TypeScript SDK](#using-the-typescript-sdk)
 - [Self-hosting & Running Locally](#self-hosting--running-locally)
 - [Repository Structure](#repository-structure)
 - [Features](#features)
 - [SDKs](#sdks)
 - [License](#license)

-### Quick Start
-
 #### Using the API endpoints
📝 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
## Quick Start
### Using the API
- [Using the API Endpoints](#using-the-api-endpoints)
- [Using the TypeScript SDK](#using-the-typescript-sdk)
- [Self-hosting & Running Locally](#self-hosting--running-locally)
- [Repository Structure](#repository-structure)
- [Features](#features)
- [SDKs](#sdks)
- [License](#license)
### Quick Start
## Quick Start
- [Using the API Endpoints](#using-the-api-endpoints)
- [Using the TypeScript SDK](#using-the-typescript-sdk)
- [Self-hosting & Running Locally](#self-hosting--running-locally)
- [Repository Structure](#repository-structure)
- [Features](#features)
- [SDKs](#sdks)
- [License](#license)
#### Using the API endpoints
🤖 Prompt for AI Agents 
In README.md around lines 22 to 32, there's a duplicate heading: a top-level "##
Quick Start" at line 22 and a redundant "### Quick Start" at line 32; remove the
latter (line 32) so the table of contents remains under the single "## Quick
Start" heading and the document heading hierarchy is consistent.


#### Using the API endpoints

How to create an inbox:
**Create an inbox:**

```curl
curl -X POST https://api.sendook.com/v1/inboxes \
Expand All @@ -37,7 +45,7 @@ curl -X POST https://api.sendook.com/v1/inboxes \
}'
```

How to send a message:
**Send a message:**

```curl
curl -X POST https://api.sendook.com/v1/inboxes/{inbox_id}/messages/send \
Expand All @@ -51,7 +59,7 @@ curl -X POST https://api.sendook.com/v1/inboxes/{inbox_id}/messages/send \
}'
```

How to create a webhook:
**Create a webhook for receiving emails:**

```curl
curl -X POST https://api.sendook.com/v1/webhooks \
Expand Down