summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRadosław Kot <rdkt13@gmail.com>2021-10-23 16:37:52 +0200
committerRadosław Kot <rdkt13@gmail.com>2021-10-23 16:58:41 +0200
commite0df1523a4569742ac10636a8cb975d11b453d54 (patch)
tree7b0a2086781846ad399ef0d10a24dc8a8a72b178
parent5ba9013b425b2d54b56a0f67149ceb2c50781638 (diff)
Add information to changelog and README
-rw-r--r--CHANGELOG.md4
-rw-r--r--README.md10
2 files changed, 14 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 05bfeca..6ec4096 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
+## 0.12.0
+ - Introduce `Format` trait [#219]
+
## 0.11.0 - 2021-03-17
- The `Config` type got a builder-pattern `with_merged()` method [#166].
- A `Config::set_once()` function was added, to set an value that can be
@@ -16,6 +19,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
[#172]: https://github.com/mehcode/config-rs/pull/172
[#169]: https://github.com/mehcode/config-rs/pull/169
[#175]: https://github.com/mehcode/config-rs/pull/169
+[#219]: https://github.com/mehcode/config-rs/pull/219
## 0.10.1 - 2019-12-07
- Allow enums as configuration keys [#119]
diff --git a/README.md b/README.md
index 1749865..ceadd99 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,8 @@
config = "0.11"
```
+### Feature flags
+
- `ini` - Adds support for reading INI files
- `json` - Adds support for reading JSON files
- `yaml` - Adds support for reading YAML files
@@ -37,6 +39,14 @@ config = "0.11"
- `ron` - Adds support for reading RON files
- `json5` - Adds support for reading JSON5 files
+### Support for custom formats
+
+Library provides out of the box support for most renowned data formats such as JSON or Yaml. Nonetheless, it contains an extensibility point - a `Format` trait that, once implemented, allows seamless integration with library's APIs using custom, less popular or proprietary data formats.
+
+See [custom_format](https://github.com/mehcode/config-rs/tree/master/examples/custom_format) example for more information.
+
+### More
+
See the [documentation](https://docs.rs/config) or [examples](https://github.com/mehcode/config-rs/tree/master/examples) for
more usage information.