summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRyan Leckey <leckey.ryan@gmail.com>2017-02-07 17:37:00 -0800
committerRyan Leckey <leckey.ryan@gmail.com>2017-02-07 17:37:00 -0800
commit33bc35e1c960b146601083fa1f2d0d602e6152ca (patch)
treeaf6e42cd0bed1d4a1d3775e8c192f5b866cae524 /README.md
parent39025a86223477b122e9f5089c18d6a68cd883ba (diff)
:memo:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 4 insertions, 12 deletions
diff --git a/README.md b/README.md
index 4dc3d7b..7aecd0d 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@
- Read from [JSON], [TOML], and [YAML] files
- Read from environment
- Loosely typed — Configuration values may be read in any supported type, as long as there exists a reasonable conversion
- - Access nested fields using a formatted path — Uses a subset of JSONPath. Currently supports the child ( `redis.port` ) and subscript operators ( `databases[0].name` )
+ - Access nested fields using a formatted path — Uses a subset of JSONPath; currently supports the child ( `redis.port` ) and subscript operators ( `databases[0].name` )
[JSON]: https://github.com/serde-rs/json
[TOML]: https://github.com/toml-lang/toml
@@ -24,10 +24,9 @@
config = "0.2"
```
-#### Features
-
- - **json** - Adds support for reading JSON files
- - **toml** - Adds support for reading TOML files (included by default)
+ - `json` - Adds support for reading JSON files
+ - `yaml` - Adds support for reading YAML files
+ - `toml` - Adds support for reading TOML files (included by default)
## Usage
@@ -77,13 +76,6 @@ fn main() {
See the [examples](https://github.com/mehcode/config-rs/tree/master/examples) for
more usage information.
-## Roadmap
- - [ ] Read from remote source — [etcd](https://github.com/jimmycuadra/rust-etcd) and [consul](https://github.com/stusmall/consul-rust)
- - [ ] Read from YAML files
- - [ ] Read from Libconfig files
-
-All suggestions are welcome. Please make an issue.
-
## License
config-rs is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).