README.md in as_deprecation_tracker-1.4.1 vs README.md in as_deprecation_tracker-1.5.0
- old
+ new
@@ -117,9 +117,23 @@
to ASDeprecationTracker::Receiver at startup, may be disabled to use multiple
behaviors (defaults to true)
* `whitelist_file` to customise the location of the whitelist YAML file
(defaults to `config/as_deprecation_whitelist.yaml`)
+### Environment variables
+
+Both `AS_DEPRECATION_` or the shorter `ASDT_` prefixes work with all
+environment variables listed below.
+
+* `AS_DEPRECATION_DISABLE` - set to any value will prevent ASDT from monitoring
+ deprecations and throwing exceptions. Rails will use default deprecation
+ behaviour.
+* `AS_DEPRECATION_RECORD` - set to any value will prevent ASDT from throwing
+ exceptions and will append entries to the `whitelist_file` for every
+ deprecation seen.
+* `AS_DEPRECATION_WHITELIST` - set to the root or full path of a whitelist
+ configuration file, overrides `whitelist_file`.
+
### Pause/resume
The processing of deprecation warnings can be suspended and resumed via the
`ASDeprecationTracker.pause!` and `ASDeprecationTracker.resume!` methods.