README.md in config-3.0.0 vs README.md in config-3.1.0
- old
+ new
@@ -203,12 +203,14 @@
You may pass a hash to `prepend_source!` as well.
## Embedded Ruby (ERB)
-Embedded Ruby is allowed in the configuration files. Consider the two following config files.
+Embedded Ruby is allowed in the YAML configuration files. ERB will be evaluated at load time by default, and when the `evaluate_erb_in_yaml` configuration is set to `true`.
+Consider the two following config files.
+
* ```#{Rails.root}/config/settings.yml```
```yaml
size: 1
server: google.com
@@ -264,9 +266,10 @@
After installing `Config` in Rails, you will find automatically generated file that contains default configuration located at `config/initializers/config.rb`.
### General
* `const_name` - name of the object holing you settings. Default: `'Settings'`
+* `evaluate_erb_in_yaml` - evaluate ERB in YAML config files. Set to false if the config file contains ERB that should not be evaluated at load time. Default: `true`
### Merge customization
* `overwrite_arrays` - overwrite arrays found in previously loaded settings file. Default: `true`
* `merge_hash_arrays` - merge hashes inside of arrays from previously loaded settings files. Makes sense only when `overwrite_arrays = false`. Default: `false`