From 2457c6040abdc56300e091287ef51f6d311a90c7 Mon Sep 17 00:00:00 2001 From: Narek Hovhannisyan Date: Tue, 22 Aug 2023 21:30:29 +0400 Subject: [PATCH] docs: add note for typescript users. --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9fe4699..8d9b02d 100644 --- a/README.md +++ b/README.md @@ -154,7 +154,23 @@ client ### Nodemailer Transport -***[Nodemailer](https://www.npmjs.com/package/nodemailer) needed as a dependency.*** +> NOTE: [Nodemailer](https://www.npmjs.com/package/nodemailer) is needed as a dependency. + +```sh +yarn add nodemailer + +# or, if you are using NPM: +npm install --s nodemailer +``` + +If you're using Typescript, install `@types/nodemailer` as a `devDependency`. + +```sh +yarn add --dev @types/nodemailer + +# or, if you are using NPM: +npm install --s-dev @types/nodemailer +``` You can provide Mailtrap specific keys like `category`, `customVariables`, `templateUuid` and `templateVariables`.