From e0df1523a4569742ac10636a8cb975d11b453d54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rados=C5=82aw=20Kot?= Date: Sat, 23 Oct 2021 16:37:52 +0200 Subject: [PATCH] Add information to changelog and README --- CHANGELOG.md | 4 ++++ README.md | 10 ++++++++++ 2 files changed, 14 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 05bfecad..6ec40964 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 17498653..ceadd993 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.