From 60de8fcc3864c8b9bac434dce0559986325176fe Mon Sep 17 00:00:00 2001 From: Dmitriy Pleshevskiy Date: Mon, 18 Jul 2022 14:36:24 +0300 Subject: [PATCH] chore: remove gitter badge --- README.md | 76 +++++++++++++++++++++++++++---------------------------- 1 file changed, 37 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 68bf3d4..4be7be0 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,30 @@ # itconfig + [![Build Status](https://travis-ci.org/icetemple/itconfig-rs.svg?branch=main)](https://travis-ci.org/icetemple/itconfig-rs) [![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/) [![Documentation](https://docs.rs/itconfig/badge.svg)](https://docs.rs/itconfig) [![Crates.io](https://img.shields.io/crates/v/itconfig)](https://crates.io/crates/itconfig) -[![Join the chat at https://gitter.im/icetemple/itconfig-rs](https://badges.gitter.im/icetemple/itconfig-rs.svg)](https://gitter.im/icetemple/itconfig-rs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) ![Crates.io](https://img.shields.io/crates/l/itconfig) 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 "] 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