chore: remove gitter badge
This commit is contained in:
parent
77d065321b
commit
60de8fcc38
GPG Key ID:
1B59187B161C0215
76
README.md
76
README.md
|
|
@ -1,30 +1,30 @@
|
|||
# itconfig
|
||||
|
||||
[](https://travis-ci.org/icetemple/itconfig-rs)
|
||||
[](https://github.com/rust-secure-code/safety-dance/)
|
||||
[](https://docs.rs/itconfig)
|
||||
[](https://crates.io/crates/itconfig)
|
||||
[](https://gitter.im/icetemple/itconfig-rs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
|
||||
Easy build a configs from environment variables and use it in globally.
|
||||
|
||||
We recommend you start with the [documentation].
|
||||
|
||||
|
||||
## Motivation
|
||||
|
||||
I began to use rust with web programming experience where environment variables are widely used
|
||||
and often there are more then 50 of them. First I looked at already created libraries.
|
||||
But there it's necessary to initialise structure that needs to be moved to each function
|
||||
where you need variable. It uses little bit memory, but configuration lifetime is as long
|
||||
as application lifetime. Because of it I decided to create my own library.
|
||||
|
||||
I began to use rust with web programming experience where environment variables
|
||||
are widely used and often there are more then 50 of them. First I looked at
|
||||
already created libraries. But there it's necessary to initialise structure that
|
||||
needs to be moved to each function where you need variable. It uses little bit
|
||||
memory, but configuration lifetime is as long as application lifetime. Because
|
||||
of it I decided to create my own library.
|
||||
|
||||
## Installation
|
||||
|
||||
These macros require a Rust compiler version 1.31 or newer.
|
||||
|
||||
Add `itconfig = { version = "1.0", features = ["macro"] }` as a dependency in `Cargo.toml`.
|
||||
Add `itconfig = { version = "1.0", features = ["macro"] }` as a dependency in
|
||||
`Cargo.toml`.
|
||||
|
||||
`Cargo.toml` example:
|
||||
|
||||
|
|
@ -38,7 +38,6 @@ authors = ["Me <user@rust-lang.org>"]
|
|||
itconfig = { version = "1.0", features = ["macro"] }
|
||||
```
|
||||
|
||||
|
||||
## Basic usage
|
||||
|
||||
```rust
|
||||
|
|
@ -94,7 +93,8 @@ fn main () {
|
|||
}
|
||||
```
|
||||
|
||||
Macro is an optional feature, disabled by default. You can use this library without macro
|
||||
Macro is an optional feature, disabled by default. You can use this library
|
||||
without macro
|
||||
|
||||
```rust
|
||||
use itconfig::*;
|
||||
|
|
@ -118,43 +118,41 @@ fn main() {
|
|||
cargo test --all-features
|
||||
```
|
||||
|
||||
|
||||
## Available features
|
||||
|
||||
* **default** - ["primitives"]
|
||||
* **macro** - Activates `config!` macros for easy configure web application.
|
||||
* **primitives** - Group for features: `numbers` and `bool`.
|
||||
* **numbers** - Group for features: `int`, `uint` and `float`.
|
||||
* **int** - Group for features: `i8`, `i16`, `i32`, `i64`, `i128` and `isize`.
|
||||
* **uint** - Group for features: `u8`, `u16`, `u32`, `u64`, `u128` and `usize`.
|
||||
* **float** - Group for features: `f32` and `f64`
|
||||
* **i8** - impl EnvString for `i8` type
|
||||
* **i16** - impl EnvString for `i16` type
|
||||
* **i32** - impl EnvString for `i32` type
|
||||
* **i64** - impl EnvString for `i64` type
|
||||
* **i128** - impl EnvString for `i128` type
|
||||
* **isize** - impl EnvString for `isize` type
|
||||
* **u8** - impl EnvString for `u8` type
|
||||
* **u16** - impl EnvString for `u16` type
|
||||
* **u32** - impl EnvString for `u32` type
|
||||
* **u64** - impl EnvString for `u64` type
|
||||
* **u128** - impl EnvString for `u128` type
|
||||
* **usize** - impl EnvString for `usize` type
|
||||
* **f32** - impl EnvString for `f32` type
|
||||
* **f64** - impl EnvString for `f64` type
|
||||
* **bool** - impl EnvString for `bool` type
|
||||
* **json_array** - Add EnvString impl for vector type (uses optional `serde_json` package). ⚠ **_DEPRECATED_**
|
||||
|
||||
- **default** - ["primitives"]
|
||||
- **macro** - Activates `config!` macros for easy configure web application.
|
||||
- **primitives** - Group for features: `numbers` and `bool`.
|
||||
- **numbers** - Group for features: `int`, `uint` and `float`.
|
||||
- **int** - Group for features: `i8`, `i16`, `i32`, `i64`, `i128` and `isize`.
|
||||
- **uint** - Group for features: `u8`, `u16`, `u32`, `u64`, `u128` and `usize`.
|
||||
- **float** - Group for features: `f32` and `f64`
|
||||
- **i8** - impl EnvString for `i8` type
|
||||
- **i16** - impl EnvString for `i16` type
|
||||
- **i32** - impl EnvString for `i32` type
|
||||
- **i64** - impl EnvString for `i64` type
|
||||
- **i128** - impl EnvString for `i128` type
|
||||
- **isize** - impl EnvString for `isize` type
|
||||
- **u8** - impl EnvString for `u8` type
|
||||
- **u16** - impl EnvString for `u16` type
|
||||
- **u32** - impl EnvString for `u32` type
|
||||
- **u64** - impl EnvString for `u64` type
|
||||
- **u128** - impl EnvString for `u128` type
|
||||
- **usize** - impl EnvString for `usize` type
|
||||
- **f32** - impl EnvString for `f32` type
|
||||
- **f64** - impl EnvString for `f64` type
|
||||
- **bool** - impl EnvString for `bool` type
|
||||
- **json_array** - Add EnvString impl for vector type (uses optional
|
||||
`serde_json` package). ⚠ **_DEPRECATED_**
|
||||
|
||||
## License
|
||||
|
||||
[MIT] © [Ice Temple](https://github.com/icetemple)
|
||||
|
||||
|
||||
## Contributors
|
||||
|
||||
[pleshevskiy](https://github.com/pleshevskiy) (Dmitriy Pleshevskiy) – creator, maintainer.
|
||||
|
||||
[pleshevskiy](https://github.com/pleshevskiy) (Dmitriy Pleshevskiy) – creator,
|
||||
maintainer.
|
||||
|
||||
[documentation]: https://docs.rs/itconfig
|
||||
[MIT]: https://github.com/icetemple/itconfig-rs/blob/master/LICENSE
|
||||
|
|
|
|||
Loading…
Reference in New Issue