update readme

update readme

Author: yanchuk

README.md

@@ -1,13 +1,44 @@
+# Mailtrap Node.js client - Official
+
 ![TypeScript](https://img.shields.io/npm/types/mailtrap?logo=typescript&logoColor=white&label=%20)
 [![test](https://github.com/railsware/mailtrap-nodejs/actions/workflows/test.yml/badge.svg)](https://github.com/railsware/mailtrap-nodejs/actions/workflows/test.yml)
 [![NPM](https://shields.io/npm/v/mailtrap?logo=npm&logoColor=white)](https://www.npmjs.com/package/mailtrap)
 [![downloads](https://shields.io/npm/d18m/mailtrap)](https://www.npmjs.com/package/mailtrap)
 
-# Official Mailtrap Node.js client
+
+## Prerequisites
+
+To get the most out of this official Mailtrap.io Node.js SDK:
+- [Create a Mailtrap account](https://mailtrap.io/signup)
+- [Verify your domain](https://mailtrap.io/sending/domains)
+
+## Supported functionality
 
 This NPM package offers integration with the [official API](https://api-docs.mailtrap.io/) for [Mailtrap](https://mailtrap.io).
 
-Quickly add email sending functionality to your Node.js application with Mailtrap.
+Quickly integrate Mailtrap with your Node.js app.
+
+Currently, with this SDK you can:
+- Email API/SMTP
+  - Send an email (Transactional and Bulk streams)
+  - Send an email with a template
+  - Send a batch of emails (Transactional and Bulk streams)
+- Email Sandbox (Testing)
+  - Send an email
+  - Send an email with a template
+  - Message management
+  - Inbox management
+  - Project management
+- Contact management
+  - Contacts CRUD
+  - Lists CRUD
+- General
+  - Templates CRUD
+  - Suppressions management (find and delete)
+  - Account access management
+  - Permissions management
+  - List accounts you have access to
+ 
 
 ## Installation
 
@@ -20,6 +51,7 @@ yarn add mailtrap
 npm install mailtrap
 ```
 
+
 ## Usage
 
 ### Minimal
@@ -51,79 +83,81 @@ client
   .catch(console.error);
 ```
 
-Refer to the [`examples`](examples) folder for the source code of this and other advanced examples.
+## Nodemailer Transport
 
-### General API
+> NOTE: [Nodemailer](https://www.npmjs.com/package/nodemailer) is needed as a dependency.
 
- - [List User & Invite account accesses](examples/general/account-accesses.ts)
- - [Remove account access](examples/general/accounts.ts)
- - [Permissions](examples/general/permissions.ts)
+```sh
+yarn add nodemailer
 
-### Contacts API
+# or, if you are using NPM:
+npm install nodemailer
+```
 
- - [Contacts](examples/contacts/everything.ts)
+If you're using TypeScript, install `@types/nodemailer` as a `devDependency`.
 
-### Contact Lists API
+```sh
+yarn add --dev @types/nodemailer
 
- - [Contact Lists](examples/contact-lists/everything.ts)
+# or, if you are using NPM:
+npm install -D @types/nodemailer
+```
 
-### Templates API
+You can provide Mailtrap-specific keys like `category`, `customVariables`, `templateUuid`, and `templateVariables`.
 
- - [Templates](examples/templates/everything.ts)
+See transport usage below:
 
-### Sending API
+- [Transport](examples/sending/transport.ts)
 
- - [Advanced](examples/sending/everything.ts)
- - [Minimal](examples/sending/minimal.ts)
- - [Send email using template](examples/sending/template.ts)
- - [Suppressions](examples/sending/suppressions.ts)
- - [Nodemailer transport](examples/sending/transport.ts)
+## Examples
 
-### Batch Sending API
+Refer to the [`examples`](examples) folder for the source code of this and other advanced examples.
 
- - [Transactional emails](examples/batch/transactional.ts)
- - [Bulk emails](examples/batch/bulk.ts)
- - [Sandbox emails](examples/batch/sandbox.ts)
- - [Emails from template](examples/batch/template.ts)
+### Contacts API
 
-### Email testing API
+- [Contacts](examples/contacts/everything.ts)
 
- - [Attachments](examples/testing/attachments.ts)
- - [Inboxes](examples/testing/inboxes.ts)
- - [Messages](examples/testing/messages.ts)
- - [Projects](examples/testing/projects.ts)
- - [Send mail using template](examples/testing/template.ts)
+### Contact Lists API
 
-### Bulk sending API
+- [Contact Lists](examples/contact-lists/everything.ts)
 
- - [Send mail](examples/bulk/send-mail.ts)
- - [Nodemailer Transport](examples/bulk/transport.ts)
+### Sending API
 
-### Nodemailer Transport
+- [Advanced](examples/sending/everything.ts)
+- [Minimal](examples/sending/minimal.ts)
+- [Send email using template](examples/sending/template.ts)
+- [Suppressions management](examples/sending/suppressions.ts)
+- [Nodemailer transport](examples/sending/transport.ts)
 
-> NOTE: [Nodemailer](https://www.npmjs.com/package/nodemailer) is needed as a dependency.
+### Batch Sending API
 
-```sh
-yarn add nodemailer
+- [Transactional emails](examples/batch/transactional.ts)
+- [Bulk emails](examples/batch/bulk.ts)
+- [Sandbox emails](examples/batch/sandbox.ts)
+- [Emails from template](examples/batch/template.ts)
 
-# or, if you are using NPM:
-npm install --s nodemailer
-```
+### Bulk Sending API
 
-If you're using Typescript, install `@types/nodemailer` as a `devDependency`.
+- [Send mail](examples/bulk/send-mail.ts)
+- [Nodemailer Transport](examples/bulk/transport.ts)
 
-```sh
-yarn add --dev @types/nodemailer
+### Templates API
 
-# or, if you are using NPM:
-npm install --s-dev @types/nodemailer
+- [Templates](examples/templates/everything.ts)
 
-You can provide Mailtrap specific keys like `category`, `customVariables`, `templateUuid` and `templateVariables`.
+### Email Sandbox (Testing) API
 
-```
-See transport usage below:
+- [Attachments](examples/testing/attachments.ts)
+- [Inboxes](examples/testing/inboxes.ts)
+- [Messages](examples/testing/messages.ts)
+- [Projects](examples/testing/projects.ts)
+- [Send mail using template](examples/testing/template.ts)
 
- - [Transport](examples/sending/transport.ts)
+### General API
+
+- [List User & Invite account accesses](examples/general/account-accesses.ts)
+- [Remove account access](examples/general/accounts.ts)
+- [Permissions](examples/general/permissions.ts)
 
 ## Development
 
@@ -141,9 +175,8 @@ The package is available as open source under the terms of the [MIT License](htt
 
 ## Code of Conduct
 
-Everyone interacting in the Mailtrap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+Everyone interacting in the Mailtrap project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
 
 ## Compatibility with previous releases
 
 Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [@vchin](https://github.com/vchin). Package version 3 is a completely new package. 
-