# Tartan Bitfield

[![Crate](https://img.shields.io/crates/v/tartan-bitfield)](https://crates.io/crates/tartan-bitfield)
[![Docs](https://img.shields.io/docsrs/tartan-bitfield)](https://docs.rs/tartan-bitfield)
[![Build](https://github.com/cimbul/tartan-bitfield/actions/workflows/build.yml/badge.svg)](https://github.com/cimbul/tartan-bitfield/actions/workflows/build.yml)
![License](https://img.shields.io/crates/l/tartan-bitfield)

{{readme}}

## Installation

Add to your Cargo.toml:
```
[dependencies]
tartan-bitfield = {{version}}
```

## Development

This is a pretty standard Rust library using Cargo.

### Tests

```
cargo test --all-targets
```

### Benchmarks

```
cargo bench
```

### Formatting/Linting

```
cargo fmt
cargo clippy --all-targets
```

## License

Licensed under either of

 * Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license
   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.

---

<small>This README was generated from doc comments. Use `cargo readme` to refresh it.</small>