README.md in rails-env-1.0.5 vs README.md in rails-env-1.0.6

- old
+ new

@@ -1,7 +1,11 @@ # rails-env +[![Build Status](https://travis-ci.org/fnando/rails-env.svg)](https://travis-ci.org/fnando/rails-env) +[![Code Climate](https://codeclimate.com/github/fnando/rails-env.png)](https://codeclimate.com/github/fnando/rails-env) +[![Gem Version](https://badge.fury.io/rb/rails-env.svg)](http://badge.fury.io/rb/rails-env) + Avoid environment detection on Rails. ## Installation Add this line to your application's Gemfile: @@ -41,9 +45,26 @@ ```ruby Rails.env.on(:any) do config.assets.version = '1.0' end ``` + +## Gotcha + +Not all options can be defined through `Rails.env`. Rails propagates options on its engine file, meaning that every option defined on `config` afterwards must be manually propagated. + +It's hard to automatically propagate every existing option, so we have the most common options covered, as you can see the list below: + +- action_controller +- action_mailer +- action_view +- active_job +- active_record +- time_zone +- auto/eager load paths +- i18n + +If you need to set any option not covered by rails-env, [please open a ticket](https://github.com/fnando/rails-env/issues/new). ## Upgrading from previous versions Previous versions used to yield the configuration; this is no longer true on 1.0+.