README.md in inky-rb-1.3.6.0 vs README.md in inky-rb-1.3.6.1
- old
+ new
@@ -1,9 +1,13 @@
# Inky
+[![Gem Version](https://badge.fury.io/rb/inky-rb.svg)](https://badge.fury.io/rb/inky-rb)
+
Inky is an HTML-based templating language that converts simple HTML into complex, responsive email-ready HTML. Designed for [Foundation for Emails](http://foundation.zurb.com/emails), a responsive email framework from [ZURB](http://zurb.com).
+To include only the Foundation for Emails styles in your Asset Pipeline, without Inky, use the [**foundation_emails**](https://github.com/zurb/foundation-emails/#using-the-ruby-gem) gem.
+
Give Inky simple HTML like this:
```html
<row>
<columns large="6"></columns>
@@ -50,26 +54,27 @@
```bash
bundle install
```
-Make sure that the stylesheet included in your email layout imports the Foundation for Emails styles:
+Run the following command to set up the required styles and mailer layout:
-```scss
-// my_awesome_emails_stylesheet.scss
-@import "foundation-emails";
+```bash
+rails g inky:install
```
+(You can specify the generated mailer layout filename like so: `rails g inky:install some_name`)
+
Rename your email templates to use the `.inky` file extension. Note that you'll still be able to use ERB within the `.inky` templates:
```
welcome.html => welcome.html.inky
pw_reset.html.erb => pw_reset.html.inky
```
You're all set!
-** The majority of email clients ignore linked stylesheets. By inlining your referenced styles, `premailer-rails` lets you keep your markup and stylesheets in separate files.
+** The majority of email clients ignore linked stylesheets. By using a CSS inliner like `premailer-rails` or `roadie`, you're able to leave your stylesheets in a separate file, keeping your markup lean.
## Custom Elements
Inky simplifies the process of creating HTML emails by expanding out simple tags like `<row>` and `<column>` into full table syntax. The names of the tags can be changed with the `components` setting.