chore: return readme
This commit is contained in:
parent
1a6f8c4f5d
commit
88cda9d254
1 changed files with 27 additions and 0 deletions
27
README.md
Normal file
27
README.md
Normal file
|
@ -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
|
Reference in a new issue