From 784e0c0d1ebc6f5553879aab37b39b735217aefd Mon Sep 17 00:00:00 2001
From: Dmitriy Pleshevskiy <dmitriy@ideascup.me>
Date: Fri, 16 Apr 2021 10:35:42 +0300
Subject: [PATCH] chore(doc): change basic usage example

---
 README.md           | 61 +++++++++++++++++++---------------------
 itconfig/src/lib.rs | 68 +++++++++++++++++++++------------------------
 2 files changed, 60 insertions(+), 69 deletions(-)

diff --git a/README.md b/README.md
index a3ef219..68bf3d4 100644
--- a/README.md
+++ b/README.md
@@ -39,7 +39,7 @@ itconfig = { version = "1.0", features = ["macro"] }
 ```
 
 
-## Example usage
+## Basic usage
 
 ```rust
 use itconfig::config;
@@ -52,50 +52,45 @@ config! {
     #[env_name = "APP_HOST"]
     HOST: String => "127.0.0.1",
 
-    DATABASE_URL < (
-        "postgres://",
-        POSTGRES_USERNAME => "user",
-        ":",
-        POSTGRES_PASSWORD => "pass",
-        "@",
-        POSTGRES_HOST => "localhost:5432",
-        "/",
-        POSTGRES_DB => "test",
-    ),
+    database {
+        URL < (
+            "postgres://",
+            POSTGRES_USERNAME => "user",
+            ":",
+            POSTGRES_PASSWORD => "pass",
+            "@",
+            POSTGRES_HOST => "localhost:5432",
+            "/",
+            POSTGRES_DB => "test",
+        ),
 
-    APP {
-        static BASE_URL => "/api", // &'static str by default
+        pool {
+            MAX_SIZE: usize => 15,
+        },
+    },
 
-        ARTICLE {
-            static PER_PAGE: u32 => 15,
-        }
+    sentry {
+        DSN: Option<&'static str>,
+    },
 
-        #[cfg(feature = "companies")]
-        COMPANY {
-            #[env_name = "INSTITUTIONS_PER_PAGE"]
-            static PER_PAGE: u32 => 15,
-        }
-    }
+    feature {
+        static CORS: bool => false,
 
-    FEATURE {
-        NEW_MENU: bool => false,
-
-        COMPANY {
-            PROFILE: bool => false,
-        }
-    }
+        static GRAPHQL_PLAYGROUND: bool => false,
+    },
 }
 
 fn main () {
     // dotenv().expect("dotenv setup to be successful");
     // or
-    env::set_var("FEATURE_NEW_MENU", "t");
+    env::set_var("FEATURE_CORS", "true");
 
     config::init();
     assert_eq!(config::HOST(), String::from("127.0.0.1"));
-    assert_eq!(config::DATABASE_URL(), String::from("postgres://user:pass@localhost:5432/test"));
-    assert_eq!(config::APP::ARTICLE::PER_PAGE(), 15);
-    assert_eq!(config::FEATURE::NEW_MENU(), true);
+    assert_eq!(config::database::URL(), String::from("postgres://user:pass@localhost:5432/test"));
+    assert_eq!(config::database::pool::MAX_SIZE(), 15);
+    assert_eq!(config::sentry::DSN(), None);
+    assert_eq!(config::feature::CORS(), true);
 }
 ```
 
diff --git a/itconfig/src/lib.rs b/itconfig/src/lib.rs
index 5615c36..54d8cfd 100644
--- a/itconfig/src/lib.rs
+++ b/itconfig/src/lib.rs
@@ -32,62 +32,58 @@
 //! ```
 //!
 //!
-//! ## Example usage
+//! ## Basic usage
 //!
 //! ```rust
 //! use itconfig::config;
 //! use std::env;
-//! // use dotenv::dotenv;
+//! //use dotenv::dotenv;
 //!
 //! config! {
-//!     DEBUG: bool => true,
+//!     DEBUG: bool => false,
+//!
+//!     #[env_name = "APP_HOST"]
 //!     HOST: String => "127.0.0.1",
 //!
-//!     DATABASE_URL < (
-//!         "postgres://",
-//!         POSTGRES_USERNAME => "user",
-//!         ":",
-//!         POSTGRES_PASSWORD => "pass",
-//!         "@",
-//!         POSTGRES_HOST => "localhost:5432",
-//!         "/",
-//!         POSTGRES_DB => "test",
-//!     ),
+//!     database {
+//!         URL < (
+//!             "postgres://",
+//!             POSTGRES_USERNAME => "user",
+//!             ":",
+//!             POSTGRES_PASSWORD => "pass",
+//!             "@",
+//!             POSTGRES_HOST => "localhost:5432",
+//!             "/",
+//!             POSTGRES_DB => "test",
+//!         ),
 //!
-//!     APP {
-//!         static BASE_URL => "/api", // &'static str by default
+//!         pool {
+//!             MAX_SIZE: usize => 15,
+//!         },
+//!     },
 //!
-//!         ARTICLE {
-//!             static PER_PAGE: u32 => 15,
-//!         }
+//!     sentry {
+//!         DSN: Option<&'static str>,
+//!     },
 //!
-//!         #[cfg(feature = "companies")]
-//!         COMPANY {
-//!             #[env_name = "INSTITUTIONS_PER_PAGE"]
-//!             static PER_PAGE: u32 => 15,
-//!         }
-//!     }
+//!     feature {
+//!         static CORS: bool => false,
 //!
-//!     FEATURE {
-//!         NEW_MENU: bool => false,
-//!
-//!         COMPANY {
-//!             PROFILE: bool => false,
-//!         }
-//!     }
+//!         static GRAPHQL_PLAYGROUND: bool => false,
+//!     },
 //! }
 //!
 //! fn main () {
 //!     // dotenv().expect("dotenv setup to be successful");
 //!     // or
-//!     env::set_var("FEATURE_NEW_MENU", "t");
+//!     env::set_var("FEATURE_CORS", "true");
 //!
 //!     config::init();
 //!     assert_eq!(config::HOST(), String::from("127.0.0.1"));
-//!     assert_eq!(config::DATABASE_URL(), String::from("postgres://user:pass@localhost:5432/test"));
-//!     assert_eq!(config::APP::BASE_URL(), "/api");
-//!     assert_eq!(config::APP::ARTICLE::PER_PAGE(), 15);
-//!     assert_eq!(config::FEATURE::NEW_MENU(), true);
+//!     assert_eq!(config::database::URL(), String::from("postgres://user:pass@localhost:5432/test"));
+//!     assert_eq!(config::database::pool::MAX_SIZE(), 15);
+//!     assert_eq!(config::sentry::DSN(), None);
+//!     assert_eq!(config::feature::CORS(), true);
 //! }
 //! ```
 //!