From f8794d6de5dcaece8734b9a5fe375f813537410f Mon Sep 17 00:00:00 2001 From: Zack Schuster Date: Fri, 6 May 2022 13:06:53 -0700 Subject: [PATCH] chore: update readme --- README.md | 37 ++++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e660122..b1da8ce 100644 --- a/README.md +++ b/README.md @@ -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