# variants
[](https://crates.io/crates/variants)
[](https://docs.rs/variants)
[](https://crates.io/crates/variants)
[](https://github.com/FL03/variants/actions/workflows/clippy.yml)
[](https://github.com/FL03/variants/actions/workflows/rust.yml)
***
_**The library is currently in the early stages of development and is not yet ready for production use.**_
Useful macros for constructing enum variants
## Features
- [x] Feature 1
## Getting Started
### Building from the source
Start by cloning the repository
```bash
git clone https://github.com/FL03/variants.git
cd variants
```
#### _Building the project_
```bash
cargo build --all-features -r -v --workspace
```
#### _Running tests_
```bash
cargo test --all-features -r -v --workspace
```
## Usage
Add this to your `Cargo.toml`:
```toml
[dependencies.variants]
features = []
version = "0.1.0"
```
### Examples
#### _Basic Usage_
```rust
extern crate variants;
fn main() -> Result<(), Box<dyn std::error::Error>> {
tracing_subscriber::fmt::init();
tracing::info!("Welcome to {name}", name = variants);
Ok(())
}
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
Please make sure to update tests as appropriate.