README.md in rails-env-1.0.7 vs README.md in rails-env-1.0.8
- old
+ new
@@ -1,29 +1,26 @@
# rails-env
-[](https://travis-ci.org/fnando/rails-env)
+[](https://github.com/fnando/rails-env)
[](https://codeclimate.com/github/fnando/rails-env)
-[](https://codeclimate.com/github/fnando/rails-env/coverage)
[](https://rubygems.org/gems/rails-env)
[](https://rubygems.org/gems/rails-env)
Avoid environment detection on Rails.
## Installation
-Add this line to your application's Gemfile:
+```bash
+gem install rails-env
+```
- gem 'rails-env'
+Or add the following line to your project's Gemfile:
-And then execute:
+```ruby
+gem "rails-env"
+```
- $ bundle
-
-Or install it yourself as:
-
- $ gem install rails-env
-
## Usage
Instead of checking for the current environment like this:
```ruby
@@ -38,11 +35,13 @@
Rails.env.on(:production) do
config.assets.version = '1.0'
end
```
-Looks dumb, but you don't have to use the long `Rails.configuration` or assign it to a local variable. This is useful when you're extracting out things to initializers.
+Looks dumb, but you don't have to use the long `Rails.configuration` or assign
+it to a local variable. This is useful when you're extracting out things to
+initializers.
To match all environments, use `:any`.
```ruby
Rails.env.on(:any) do
@@ -50,28 +49,34 @@
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.
+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:
+It's hard to automatically propagate every existing option, so we have the most
+common options covered, as you can see in the list below:
- action_controller
- action_mailer
- action_view
- active_job
- active_record
- time_zone
- auto/eager load paths
- i18n
+- hosts
-If you need to set any option not covered by rails-env, [please open a ticket](https://github.com/fnando/rails-env/issues/new).
+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+.
+Previous versions used to yield the configuration; this is no longer true on
+1.0+.
So, instead of using
```ruby
Rails.env.on(:development) do |config|
@@ -85,12 +90,29 @@
Rails.env.on(:development) do
config.assets.version = '1.0'
end
```
+## Maintainer
+
+- [Nando Vieira](https://github.com/fnando)
+
+## Contributors
+
+- https://github.com/fnando/rails-env/contributors
+
## Contributing
-1. Fork it ( https://github.com/fnando/rails-env/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+For more details about how to contribute, please read
+https://github.com/fnando/rails-env/blob/main/CONTRIBUTING.md.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
+found at https://github.com/fnando/rails-env/blob/main/LICENSE.md.
+
+## Code of Conduct
+
+Everyone interacting in the rails-env project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/rails-env/blob/main/CODE_OF_CONDUCT.md).