README.md in inky-rb-0.0.3 vs README.md in inky-rb-1.3.6.0

- old
+ new

@@ -34,31 +34,42 @@ </tr> </tbody> </table> ``` -## Installation +## Getting Started -Add this line to your application's Gemfile: +Add the following gems to your Gemfile: - $ gem 'foundation-rails', require: 'inky' +```ruby +gem 'inky-rb', require: 'inky' +# Stylesheet inlining for email ** +gem 'premailer-rails' +``` -And then execute: +Then execute: - $ bundle +```bash +bundle install +``` -Or install it yourself as: +Make sure that the stylesheet included in your email layout imports the Foundation for Emails styles: - $ gem install foundation-rails +```scss +// my_awesome_emails_stylesheet.scss +@import "foundation-emails"; +``` -## Usage +Rename your email templates to use the `.inky` file extension. Note that you'll still be able to use ERB within the `.inky` templates: -Inky can be embedded into your asset pipeline, combining with premailer to let you generate amazing HTML emails without the nightmare of table-based email development. - -Simply use the file extension `.inky` and make sure your email layout includes a scss file that includes the foundation-emails styles. ``` -@import 'foundation-emails' +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. ## 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.