chore: update readme

This commit is contained in:
Zack Schuster 2022-05-06 13:06:53 -07:00
parent ad2e3231a3
commit f8794d6de5
1 changed files with 26 additions and 11 deletions

View File

@ -3,8 +3,9 @@
send emails, html and attachments (files, streams and strings) from node.js to any smtp server
## INSTALLING
npm install emailjs
```console
$ npm install emailjs # or yarn, pnpm, etc.
```
## FEATURES
@ -22,6 +23,29 @@ send emails, html and attachments (files, streams and strings) from node.js to a
- auth access to an SMTP Server
- if your service (ex: gmail) uses two-step authentication, use an application specific password
## DEVELOPMENT
issues and pull requests are welcome!
### Setup
#### node 14+
```console
$ corepack enable yarn # if necessary to install or update
$ yarn
```
#### node 12
```console
$ npm install --global yarn # if necessary to install or update; see https://classic.yarnpkg.com/en/docs/install
$ yarn
```
### Testing
```console
$ yarn test
```
## EXAMPLE USAGE - text only emails
```js
@ -309,12 +333,3 @@ associative array of currently supported SMTP authentication mechanisms
eleith
zackschuster
## Testing
npm install -d
npm test
## Contributions
issues and pull requests are welcome