diff --git a/README.md b/README.md index 3b5dc37..a795bca 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,8 @@ bundle install Make sure that the stylesheet included in your email layout imports the Foundation for Emails styles: ```scss -// my_awesome_emails_stylesheet.scss +// app/assets/stylesheets/your_emails_stylesheet.scss + @import "foundation-emails"; ``` @@ -66,9 +67,38 @@ welcome.html => welcome.html.inky pw_reset.html.erb => pw_reset.html.inky ``` +Ensure your mailer layout has the following structure: + +```html + + + + + + + + + + + + + + + + + +
+
+ <%= yield %> +
+
+ + +``` + 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