README.md in qonfig-0.11.0 vs README.md in qonfig-0.12.0
- old
+ new
@@ -37,11 +37,11 @@
- [Load from \_\_END\_\_](#load-from-__end__) (aka `load_from_self`)
- [Save to JSON file](#save-to-json-file) (`save_to_json`)
- [Save to YAML file](#save-to-yaml-file) (`save_to_yaml`)
- [Smart Mixin](#smart-mixin) (`Qonfig::Configurable`)
- [Plugins](#plugins)
-
+ - [toml](#plugin-toml) (provides `load_from_toml`, `save_to_toml`, `expose_toml`)
---
### Definition and Access
```ruby
@@ -817,11 +817,11 @@
},
"enabled": true
}
```
-#### With value preprocessing
+#### With value preprocessing and custom options
```ruby
class AppConfig < Qonfig::DataSet
setting :server do
setting :address, 'localhost'
@@ -1041,9 +1041,32 @@
# --- load specific plugin ---
Qonfig.plugin(:plugin_name) # or Qonfig.plugin('plugin_name')
```
---
+
+### Plugins: toml
+
+- adds support for `toml` format ([specification](https://github.com/toml-lang/toml));
+- depends on `toml-rb` gem;
+- provides `load_from_toml` (works in `load_from_yaml` manner [doc](#load-from-yaml-file));
+- provides `save_to_toml` (works in `save_to_yaml` manner [doc](#save-to-yaml-file)) (`toml-rb` has no native options);
+- provides `expose_toml` (works in `expose_yaml` manner [doc](#expose-yaml));
+
+```ruby
+require 'toml-rb'
+Qonfig.plugin(:toml)
+# and use :)
+```
+---
+
+## Roadmap
+
+- support for TOML format;
+- explicit "settings" object;
+- validation layer;
+- distributed configuration server;
+- support for Rails-like secrets;
## Contributing
- Fork it ( https://github.com/0exp/qonfig/fork )
- Create your feature branch (`git checkout -b feature/my-new-feature`)