summaryrefslogtreecommitdiffstats
path: root/src/lib.rs
diff options
context:
space:
mode:
authorRyan Leckey <ryan@launchbadge.com>2017-06-13 02:21:46 -0700
committerRyan Leckey <ryan@launchbadge.com>2017-06-13 02:21:46 -0700
commitab0d8cb9aa107c8d561f3c188e6cbf472a7df23b (patch)
tree80545ea4305763bbf47a9bd33f4da99d6c9b985b /src/lib.rs
parentbabd49242c04e783ae27ea159e2bc42d24490520 (diff)
:shirt: Fix clippy warnings
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs20
1 files changed, 20 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 212e621..5d06364 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,6 +1,26 @@
+//! Config organizes hierarchical or layered configurations for Rust applications.
+//!
+//! Config lets you set a set of default parameters and then extend them via merging in
+//! configuration from a variety of sources:
+//! - Environment variables
+//! - Another Config instance
+//! - Remote configuration: etcd, Consul
+//! - Files: JSON, YAML, TOML
+//! - Manual, programmatic override (via a `.set` method on the Config instance)
+//!
+//! Additionally, Config supports:
+//! - Live watching and re-reading of configuration files
+//! - Deep access into the merged configuration via a path syntax
+//! - Deserialization via `serde` of the configuration or any subset defined via a path
+//!
+//! See the [examples](https://github.com/mehcode/config-rs/tree/master/examples) for
+//! general usage information.
+
#![allow(dead_code)]
#![allow(unused_imports)]
#![allow(unused_variables)]
+#![allow(unknown_lints)]
+// #![warn(missing_docs)]
#[macro_use]
extern crate serde;