Skip to content

Commit

Permalink
feat: added iOS Simulator support 🎉
Browse files Browse the repository at this point in the history
  • Loading branch information
titanism committed Jul 22, 2022
1 parent edac7f4 commit f9bf71a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://lass.js.org)
[![license](https://img.shields.io/github/license/forwardemail/email-templates.svg)](LICENSE)

Create, [preview][preview-email], and send custom email templates for [Node.js][node]. Highly configurable and supports automatic inline CSS, stylesheets, embedded images and fonts, and much more! Made for [Forward Email][forward-email] and [Lad][].
Create, [preview][preview-email] (in the browser and in the iOS Simulator), and send custom email templates for [Node.js][node]. Highly configurable and supports automatic inline CSS, stylesheets, embedded images and fonts, and much more! Made for [Forward Email][forward-email] and [Lad][].


## Table of Contents
Expand Down Expand Up @@ -59,7 +59,7 @@ npm install email-templates pug

## Preview

We've added [preview-email][] by default to this package!
We've added [preview-email][] by default to this package! This package allows you to preview emails in the browser and in the iOS Simulator.

This means that (by default) in the development environment (e.g. `NODE_ENV=development`) your emails will be rendered to the tmp directory for you and automatically opened in the browser.

Expand Down Expand Up @@ -780,7 +780,7 @@ For a list of all available options and defaults [view the configuration object]
* `pretty` (Boolean) - defaults to `true`, but is automatically set to `false` for subject templates and text-based emails
* `message` (Object) - default [Nodemailer message object][nodemailer-message-object] for messages to inherit (defaults to an empty object `{}`)
* `send` (Boolean) - whether or not to send emails, defaults to `false` for `development` and `test` environments, and `true` for all others (via `process.env.NODE_ENV`) (**NOTE: IF YOU ARE NOT USING `NODE_ENV` YOU WILL NEED TO MANUALLY SET THIS TO `true`**)
* `preview` (Boolean or Object) - whether or not to preview emails using [preview-email][], defaults to `false` unless the environment is `development` (via `process.env.NODE_ENV`)
* `preview` (Boolean or Object) - whether or not to preview emails using [preview-email][], defaults to `false` unless the environment is `development` (via `process.env.NODE_ENV`) – if you wish to disable the iOS Simulator then pass `{ openSimulator: false }`
* `i18n` (Boolean or Object) - translation support for email templates, this accepts an I18N configuration object (defaults to `false`, which means it is disabled) which is passed along to [@ladjs/i18n][i18n] – see [Localization](#localization) example for more insight
* `render` (Function) - defaults to a stable function that accepts two argument, `view` (String) and `locals` (Object) - you should not need to set this unless you have a need for custom rendering (see [Custom Rendering (e.g. from a MongoDB database)](#custom-rendering-eg-from-a-mongodb-database))
* `customRender` (Boolean) - defaults to `false`, unless you pass your own `render` function, and in that case it will be automatically set to `true`
Expand Down
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,23 @@
"Nick Baugh <[email protected]> (http://niftylettuce.com)"
],
"dependencies": {
"@ladjs/i18n": "^8.0.0",
"@ladjs/i18n": "^8.0.1",
"consolidate": "^0.16.0",
"get-paths": "^0.0.7",
"html-to-text": "^8.2.0",
"juice": "^8.0.0",
"lodash": "^4.17.21",
"nodemailer": "^6.7.6",
"preview-email": "^3.0.5"
"nodemailer": "^6.7.7",
"preview-email": "^3.0.7"
},
"devDependencies": {
"@commitlint/cli": "^17.0.3",
"@commitlint/config-conventional": "^17.0.3",
"ava": "^4.3.0",
"ava": "^4.3.1",
"cheerio": "^1.0.0-rc.12",
"cross-env": "^7.0.3",
"ejs": "^3.1.8",
"eslint": "^8.19.0",
"eslint": "^8.20.0",
"eslint-config-xo-lass": "^2.0.1",
"fixpack": "^4.0.0",
"husky": "^8.0.1",
Expand All @@ -37,7 +37,7 @@
"pug": "^3.0.2",
"remark-cli": "^11.0.0",
"remark-preset-github": "^4.0.4",
"xo": "^0.50.0"
"xo": "^0.51.0"
},
"engines": {
"node": ">=14"
Expand Down

0 comments on commit f9bf71a

Please sign in to comment.