A free and open-source block-based email template builder.
TypeScript amazonsesdeveloper-toolsemailemail-editoremail-marketingemail-templateemail-template-builderemailapiemailjshtml-email-editorno-codenocode-email-editoropen-source-email-buildersendgridtransactional-emailswysiwyg-email-editorwysiwyg-html-editor
[documentation] Updating README with correct renderToStaticMarkup function (#89)
Jordan Isip0ffa4af7ad06
diff --git a/README.md b/README.mdindex 8bf27a4..af7cce9 100644--- a/README.md+++ b/README.md@@ -124,9 +124,9 @@ const CONFIGURATION: TReaderDocument = {You can render the EmailBuilder.js configuration to an HTML email string:```javascript-import { renderHtmlDocument } from '@usewaypoint/email-builder';+import { renderToStaticMarkup } from '@usewaypoint/email-builder';-const string = renderHtmlDocument(CONFIGURATION, 'root');+const string = renderToStaticMarkup(CONFIGURATION, { rootBlockId: 'root' });```Or you can render the EmailBuilder.js configuration by using the `<Reader />` React component:@@ -148,7 +148,7 @@ In most cases, you'll want to take the EmailBuilder.js configuration, render it### Sending through nodemailer```javascript-import { renderHtmlDocument } from '@usewaypoint/email-builder';+import { renderToStaticMarkup } from '@usewaypoint/email-builder';import nodemailer from "nodemailer";// Replace this with your transport configuration@@ -162,7 +162,7 @@ await transporter.sendMail({from: '[email protected]'to: '[email protected]',subject: 'Hello',- html: renderHtmlDocument(CONFIGURATION, 'root'),+ html: renderToStaticMarkup(CONFIGURATION, { rootBlockId: 'root' }),});```@@ -175,7 +175,7 @@ We'll use [Waypoint](https://www.usewaypoint.com) for this example, however, you```javascriptimport axios from 'axios';-import { renderHtmlDocument } from '@usewaypoint/email-builder';+import { renderToStaticMarkup } from '@usewaypoint/email-builder';// Replace this with the JSON for your Reader documentconst CONFIGURATION: TReaderDocument = {}@@ -195,7 +195,7 @@ await axios({from: '[email protected]'to: '[email protected]',subject: 'Hello',- bodyHtml: renderHtmlDocument(CONFIGURATION, 'root'),+ bodyHtml: renderToStaticMarkup(CONFIGURATION, { rootBlockId: 'root' }),},});```