summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRyan Leckey <leckey.ryan@gmail.com>2017-02-12 10:15:42 -0800
committerGitHub <noreply@github.com>2017-02-12 10:15:42 -0800
commit63dbca6b071b1e4e872af96325b2865bb950b147 (patch)
tree1ff88197a760273a6b599f8839aa3e01ce86c075
parent6a2c9ae4f16f67bb710ce400635476a543d2259a (diff)
Update README.md
-rw-r--r--README.md49
1 files changed, 2 insertions, 47 deletions
diff --git a/README.md b/README.md
index f7fcbf7..705a46d 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@
[TOML]: https://github.com/toml-lang/toml
[YAML]: https://github.com/chyh1990/yaml-rust
-## Install
+## Usage
```toml
[dependencies]
@@ -29,52 +29,7 @@ config = "0.2"
- `yaml` - Adds support for reading YAML files
- `toml` - Adds support for reading TOML files (included by default)
-## Usage
-
-Configuration is gathered by building a `Source` and then merging that source into the
-current state of the configuration.
-
-```rust
-fn main() {
- // Add environment variables that begin with RUST_
- config::merge(config::Environment::new("RUST"));
-
- // Add 'Settings.json'
- config::merge(config::File::new("Settings", config::FileFormat::Json));
-
- // Add 'Settings.$(RUST_ENV).json`
- let name = format!("Settings.{}", config::get_str("env").unwrap());
- config::merge(config::File::new(&name, config::FileFormat::Json));
-}
-```
-
-Note that in the above example the calls to `config::merge` could have
-been re-ordered to influence the priority as each successive merge
-is evaluated on top of the previous.
-
-Configuration values can be retrieved with a call to `config::get` and then
-coerced into a type with `as_*`.
-
-```toml
-# Settings.toml
-debug = 1
-```
-
-```rust
-fn main() {
- // Add 'Settings.toml' (from above)
- config::merge(config::File::new("Settings", config::FileFormat::Toml));
-
- // Get 'debug' and coerce to a boolean
- assert_eq!(config::get("debug").unwrap().as_bool(), Some(true));
-
- // You can use a type suffix on `config::get` to simplify
- assert_eq!(config::get_bool("debug"), Some(true));
- assert_eq!(config::get_str("debug"), Some("true"));
-}
-```
-
-See the [examples](https://github.com/mehcode/config-rs/tree/master/examples) for
+See the [documentation](https://docs.rs/config) or [examples](https://github.com/mehcode/config-rs/tree/master/examples) for
more usage information.
## License