From 88cda9d254198caaf9fe381b3d7d46f3eaf445fe Mon Sep 17 00:00:00 2001
From: Dmitriy Pleshevskiy <dmitriy@ideascup.me>
Date: Mon, 23 Dec 2019 15:24:36 +0300
Subject: [PATCH] chore: return readme

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6755b6c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# itconfig
+
+Easy build a configs from environment variables and use it in globally.
+
+We recommend you start with the [documentation].
+
+
+## Example usage
+
+```rust
+#[macro_use] extern crate itconfig;
+use dotenv::dotenv;
+
+config! {
+    DATABASE_URL: bool,
+    HOST: String => "127.0.0.1".to_string(),
+}
+
+fn main () {
+    dotenv().ok();
+    cfg::init();
+    assert_eq(cfg::HOST(), String::from("127.0.0.1");
+}
+```
+
+
+[documentation]: https://docs.rs/itconfig