This repository has been archived on 2022-07-24. You can view files and clone it, but cannot push or open issues or pull requests.
itconfig/README.md

59 lines
1 KiB
Markdown
Raw Normal View History

2019-12-23 15:24:36 +03:00
# itconfig
2019-12-24 19:37:55 +03:00
[![Documentation](https://docs.rs/itconfig/badge.svg?version=0.2.3)](https://docs.rs/itconfig)
2019-12-23 15:24:36 +03:00
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! {
2019-12-24 19:37:55 +03:00
DEBUG: bool => true,
2019-12-23 15:24:36 +03:00
HOST: String => "127.0.0.1".to_string(),
2019-12-25 11:03:33 +03:00
NAMESPACE {
FOO: bool => true,
BAR: i32 => 10,
}
2019-12-23 15:24:36 +03:00
}
fn main () {
dotenv().ok();
cfg::init();
assert_eq(cfg::HOST(), String::from("127.0.0.1");
}
```
2019-12-24 19:37:55 +03:00
## Running tests
```bash
cargo test
```
## Roadmap
* [ ] Add namespace for variables
* [ ] Custom env name
* [ ] Add if condition for feature variables
## License
[MIT] © [Ice Temple](https://github.com/icetemple)
## Contributors
[pleshevskiy](https://github.com/pleshevskiy) (Dmitriy Pleshevskiy) creator, maintainer.
2019-12-23 15:24:36 +03:00
[documentation]: https://docs.rs/itconfig
2019-12-24 19:37:55 +03:00
[MIT]: https://github.com/icetemple/itconfig-rs/blob/master/LICENSE