Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nickforddev committed Oct 3, 2017
1 parent 0b88a24 commit 5a2286f
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Notifire

> A tool for designing app-related emails, push notifications, and sms notifications
> A tool for designing app-related emails, push notifications, and sms notifications using handlebars templates
## Installation

Expand All @@ -25,12 +25,20 @@ Create a new template or select an existing one, then click edit. This will open

## Templates

Templates are a group that represent a single notification, each containing an email, a push notification, and a text message. [http://handlebarsjs.com/expressions.html](http://handlebarsjs.com/expressions.html)
Templates are a group that represent a single notification, each containing an email, a push notification, and a text message. All templates should be in handlebars formatting, and are rendered using Hogan.js. Global and template-specific json files should be used as a means of mocking data that your production app will later provide. [http://handlebarsjs.com/expressions.html](http://handlebarsjs.com/expressions.html)

## Styles

Styles are rendered using node-sass (css/sass/scss all supported), and are first scoped to individual templates/partials, then global templates. This means that stylesheets for specific templates will never affect elements outside of that particular template. All styles will be autoprefixed and inlined during build.

## Partials

Partials allow you to reuse components within your templates. [http://handlebarsjs.com/partials.html](http://handlebarsjs.com/partials.html)

## Globals

Globals are elements that are shared between all templates. Your global template will wrap every email template, global json will be available to every template, global styles will be applied to every template.
Globals are elements that are shared between all templates. Your global template will wrap every email template, global json will be available to every template, global styles will be applied to every template.

## Build

When you are ready to export your templates for use in production, click the build button. This will render all templates with autoprefixed and inlined css to the ./dist folder, at which point your templates are ready to send!

0 comments on commit 5a2286f

Please sign in to comment.