Added documentation for inject util

justinsisley · Aug 8, 2016 · 26de362 · 26de362
1 parent a32a2b2
commit 26de362
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -84,6 +84,39 @@ npm run email-send
 
 This is the preferred way of using __mjml-utils__, since you can configure it on a per-project basis, and you won't have to remember any command line arguments other than the simple NPM script alias.
 
+## Module Usage
+
+__mjml-utils__ also has a built in helper method called `inject`. An example of its usage is below:
+
+```javascript
+const mjmlUtils = require('mjml-utils');
+const pathToHtmlEmailTemplate = path.join(__dirname, '../emails/welcome.html');
+
+mjmlUtils.inject(pathToHtmlEmailTemplate, {
+  name: 'bob',
+  profileURL: 'https://app.com/bob',
+})
+.then(finalTemplate => {
+  // finalTemplate is an HTML string containing the template with all occurrences
+  // of `{name}` replaced with "bob", and all occurrences of `{profileURL}`
+  // replaced with "https://app.com/bob".
+});
+```
+
+The above JavaScript assumes a template called `welcome.html` exists at the specified path, and that it's contents are something like the following example:
+
+```html
+<html>
+  <body>
+    <h1>Welcome {name}</h1>
+
+    <p><a href="{profileURL}">Click here</a> to view your profile.</p>
+  </body>
+</html>
+```
+
+This means your raw MJML template should contain the necessary template strings that you intend to replace with dynamic values.
+
 ## Versioning
 
 To keep better organization of releases this project follows the [Semantic Versioning 2.0.0](http://semver.org/) guidelines.

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "mjml-utils",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "author": "Justin Sisley <[email protected]>",
   "description": "The utility belt for MJML developers",
   "repository": "https://github.com/justinsisley/mjml-utils",