Skip to content

Updated README.md#13

Open
ru4ert wants to merge 3 commits intoxpepermint:masterfrom
ru4ert:master
Open

Updated README.md#13
ru4ert wants to merge 3 commits intoxpepermint:masterfrom
ru4ert:master

Conversation

@ru4ert
Copy link
Copy Markdown

@ru4ert ru4ert commented Jul 14, 2021

Fixed Typos

# smtp-client

> Simple, promisified, protocol-based SMTP client for Node.js.
> Simple promised, protocol-based SMTP client for Node.js.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Promisify is a method that defines in utilities module of Node. js the standard library, so "promisified" is correct.

> Simple promised, protocol-based SMTP client for Node.js.

This is an open source [npm](http://npmjs.com) package from [Node.js](http://nodejs.org). The source code is available on [GitHub](https://github.com/xpepermint/smtp-client) where you can also find our [issue tracker](https://github.com/xpepermint/smtp-client/issues).
This is an open-source [npm](http://npmjs.com) package from [Node.js](http://nodejs.org). The source code is available on [GitHub](https://github.com/xpepermint/smtp-client) where you can also find our [issue tracker](https://github.com/xpepermint/smtp-client/issues).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Open-source in this case is used as an adjective, and the correct spelling is in fact "open-source", as suggested.

**SMTPClient.prototype.connect({timeout})**:Promise;

> Connects to the SMTP server and starts socket I/O activity.
> Connects to the SMTP server and starts to socket I/O activity.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

A socket is one endpoint of a two-way communication link between two programs running on the network.
The "socket I/0 activity" is correct.

**SMTPClient.prototype.data(source, {sourceSize, timeout})**:Promise;

> Sends the DATA command to the server which uploads the `source` of an email and finalize the process with the `.` (automatically appended to the source).
> Sends the DATA command to the server which uploads the `source` of an email and finalizes the process with the `.` (automatically appended to the source).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Finalize can in this instance be interpreted as command, therefore it is correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants