Skip to content

Commit

Permalink
docs: fixed README and added v7.0.0 changes
Browse files Browse the repository at this point in the history
  • Loading branch information
niftylettuce committed Jan 20, 2020
1 parent bb8c2de commit f60d9c6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# [**Email Templates**](https://github.com/niftylettuce/email-templates)
# [**Email Templates**](https://github.com/forwardemail/email-templates)

[![build status](https://travis-ci.com/forwardemail/email-templates.svg)](https://travis-ci.com/forwardemail/email-templates)
[![code coverage](https://img.shields.io/codecov/c/github/niftylettuce/email-templates.svg)](https://codecov.io/gh/niftylettuce/email-templates)
[![code coverage](https://img.shields.io/codecov/c/github/forwardemail/email-templates.svg)](https://codecov.io/gh/forwardemail/email-templates)
[![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://lass.js.org)
[![license](https://img.shields.io/github/license/niftylettuce/email-templates.svg)](LICENSE)
[![license](https://img.shields.io/github/license/forwardemail/email-templates.svg)](LICENSE)

> :heart: Love this project? Support <a href="https://github.com/niftylettuce" target="_blank">@niftylettuce's</a> [FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) on <a href="https://patreon.com/niftylettuce" target="_blank">Patreon</a> or <a href="https://paypal.me/niftylettuce">PayPal</a> :unicorn:
Expand Down Expand Up @@ -35,6 +35,7 @@ Create, [preview][preview-email], and send custom email templates for [Node.js][
* [Options](#options)
* [Plugins](#plugins)
* [Breaking Changes](#breaking-changes)
* [v7.0.0](#v700)
* [v6.0.0](#v600)
* [v5.0.0](#v500)
* [v4.0.0](#v400)
Expand Down Expand Up @@ -610,7 +611,7 @@ const email = new Email({

### Absolute Path to Templates

As of v5.0.1+ we now support passing absolute paths to templates for rendering (per discussion in [#320](https://github.com/niftylettuce/email-templates/issues/320).
As of v5.0.1+ we now support passing absolute paths to templates for rendering (per discussion in [#320](https://github.com/forwardemail/email-templates/issues/320).

For both `email.send` and `email.render`, the `template` option passed can be a relative path or absolute:

Expand Down Expand Up @@ -733,7 +734,11 @@ We also highly recommend to add to your default `config.locals` the following:

## Breaking Changes

See the [Releases](https://github.com/niftylettuce/email-templates/releases) page for an up to date changelog.
See the [Releases](https://github.com/forwardemail/email-templates/releases) page for an up to date changelog.

### v7.0.0

We upgraded `preview-email` to `v2.0.0`, which supports stream attachments, and additionally the view rendering is slightly different (we simply iterate over header lines and format them in a `<pre><code>` block). A major version bump was done due to the significant visual change in the preview rendering of emails.

### v6.0.0

Expand All @@ -760,7 +765,7 @@ See the [Releases](https://github.com/niftylettuce/email-templates/releases) pag

### v5.0.0

In version 4.x+, we changed the order of defaults being set. See [#313](https://github.com/niftylettuce/email-templates/issues/313) for more information. This allows you to override message options such as `from` (even if you have a global default `from` set).
In version 4.x+, we changed the order of defaults being set. See [#313](https://github.com/forwardemail/email-templates/issues/313) for more information. This allows you to override message options such as `from` (even if you have a global default `from` set).

### v4.0.0

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"version": "7.0.0",
"author": "Nick Baugh <niftylettuce@gmail.com> (http://niftylettuce.com)",
"bugs": {
"url": "https://github.com/niftylettuce/email-templates/issues",
"url": "https://github.com/forwardemail/email-templates/issues",
"email": "niftylettuce@gmail.com"
},
"commitlint": {
Expand Down Expand Up @@ -59,7 +59,7 @@
"lib",
"locales"
],
"homepage": "https://github.com/niftylettuce/email-templates",
"homepage": "https://github.com/forwardemail/email-templates",
"husky": {
"hooks": {
"pre-commit": "npm test",
Expand Down Expand Up @@ -115,7 +115,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/niftylettuce/email-templates"
"url": "https://github.com/forwardemail/email-templates"
},
"scripts": {
"ava": "cross-env NODE_ENV=test ava",
Expand Down

0 comments on commit f60d9c6

Please sign in to comment.