README.md in anyway_config-1.0.0.rc1 vs README.md in anyway_config-1.0.0
- old
+ new
@@ -2,12 +2,14 @@
# Anyway Config
Rails/Ruby plugin/application configuration tool which allows you to load parameters from different sources: YAML, Rails secrets, environment.
-Apps using AnywayConfig:
+Allows you to easily follow the [twelve-factor application](https://12factor.net/config) principles and adds zero complexity to your development process.
+Libraries using Anyway Config:
+
- [Influxer](https://github.com/palkan/influxer)
- [AnyCable](https://github.com/anycable/anycable)
- [and others](https://github.com/palkan/anyway_config/network/dependents).
@@ -72,11 +74,11 @@
MyCoolGem.config.user #=> 'root'
```
#### Customize name
-By default, AnywayConfig uses the namespace (the outer module name) as the config name, but you can set it manually:
+By default, Anyway Config uses the namespace (the outer module name) as the config name, but you can set it manually:
```ruby
module MyCoolGem
class Config < Anyway::Config
config_name :cool
@@ -104,11 +106,11 @@
- `ENV['MYCOOLGEM_*']`.
### Using with Ruby
-By default AnywayConfig is looking for a config YAML at `./config/<config-name>.yml`. You can override this setting
+By default, Anyway Config is looking for a config YAML at `./config/<config-name>.yml`. You can override this setting
through special environment variable – 'MYGEM_CONF' – containing the path to the YAML file.
Environmental variables work the same way as with Rails.
@@ -120,10 +122,10 @@
## `Rails.application.config_for` vs `Anyway::Config.for`
Rails 4.2 introduced new feature: `Rails.application.config_for`. It looks very similar to
`Anyway::Config.for`, but there are some differences:
-| Feature | Rails | Anyway |
+| Feature | Rails | Anyway Config |
| ------------- |:-------------:| -----:|
| load data from `config/app.yml` | yes | yes |
| load data from `secrets` | no | yes |
| load data from environment | no | yes |
| return Hash with indifferent access | no | yes |