README.md in premailer-rails3-1.3.1 vs README.md in premailer-rails3-1.3.2
- old
+ new
@@ -1,11 +1,14 @@
-# premailer-rails3
+# premailer-rails
-[](http://travis-ci.org/fphilipe/premailer-rails3) [](https://codeclimate.com/github/fphilipe/premailer-rails3)
+[](https://travis-ci.org/fphilipe/premailer-rails)
+[](http://badge.fury.io/rb/premailer-rails)
+[](https://gemnasium.com/fphilipe/premailer-rails)
+[](https://codeclimate.com/github/fphilipe/premailer-rails)
This gem is a no config solution for the wonderful
-[Premailer gem](https://github.com/alexdunae/premailer) to be used with Rails 3.
+[Premailer gem](https://github.com/alexdunae/premailer) to be used with Rails.
It uses interceptors which were introduced in Rails 3 and tweaks all mails which
are `deliver`ed and adds a plain text part to them and inlines all CSS rules
into the HTML part.
By default it inlines all the CSS files that are linked to in the HTML:
@@ -14,16 +17,13 @@
<link type='text/css' ... />
```
Don't worry about the host in the CSS URL since this will be ignored.
-If no CSS file is linked to in the HTML and no inline `<style type="text/css">`
-is presnet, it will try to load a default CSS file `email.css`.
+Every CSS file is loaded from within the app.
+The retrieval of the file depends on your assets configuration:
-Every CSS file (including the default `email.css`) is loaded from within the
-app. The retrieval of the file depends on your assets configuration:
-
* Rails 3.1 asset pipeline: It will load the compiled version of the CSS asset
which is normally located in `app/assets/stylesheets/`. If the asset can't be
found (e.g. it is only available on a CDN and not locally), it will be
HTTP requested.
@@ -36,13 +36,13 @@
## Installation
Simply add the gem to your Gemfile in your Rails project:
- gem 'premailer-rails3'
+ gem 'premailer-rails'
-premailer-rails3 requires either nokogiri or hpricot. It doesn't list them as a
+premailer-rails requires either nokogiri or hpricot. It doesn't list them as a
dependency so you can choose which one to use.
gem 'nokogiri'
# or
gem 'hpricot'
@@ -51,16 +51,16 @@
That's it!
## Configuration
-Premailer itself accepts a number of options. In order for premailer-rails3 to
+Premailer itself accepts a number of options. In order for premailer-rails to
pass these options on to the underlying premailer instance, specify them in an
initializer:
```ruby
-PremailerRails.config.merge!(:preserve_styles => true,
- :remove_ids => true)
+Premailer::Rails.config.merge!(:preserve_styles => true,
+ :remove_ids => true)
```
For a list of options, refer to the [Premailer documentation](http://rubydoc.info/gems/premailer/1.7.3/Premailer:initialize)
The default configs are: