search

Thomascogez / nodemailer-mjml

Nodemailer plugin for easily sending mjml mail
https://www.npmjs.com/package/nodemailer-mjml
12 stars 3 forks source link

Incorrect Import Path in Usage examples for nodemailerMjmlPlugin #309

Open adarsht0001 opened 6 days ago

adarsht0001 commented 6 days ago

In the usage examples the import for nodemailerMjmlPlugin is from "../src/index".

image

Suggested fix:

import { nodemailerMjmlPlugin } from "nodemailer-mjml";

Thomascogez commented 4 days ago

Hello, thanks for you interested for the project !
It was first intended to make examples working locally, but I assume it can be misleading.

Would you like to open a PR for this ? I think it can also be interesting to also include a package.json and a minimal tsconfig.json inside the example folder ?

adarsht0001 commented 3 days ago

Hello, Thank you for the response! Just to clarify, my concern was actually regarding the README file, not the examples folder. The import path in the examples code block in the README , which might be confusing for users. I'd be happy to open a PR to update this, along with adding a package.json and a minimal tsconfig.json inside the example folder for additional clarity.