# Chickenwire
A library for representing and manipulating hexagonal grids in Rust.

## Contents
1. [Installation](#installation)
2. [Usage](#usage)
3. [Documentation](#documentation)
4. [Contributing](#contributing)
5. [Credits](#credits)
6. [License](#license)

## Installation
Add the following to your project's `Cargo.toml` file under `[dependencies]`:

```toml
chickenwire = "0.1.0"
```

Check out [Chickenwire's Cargo page]() for the latest version info.

## Usage
[Documentation needed]

## Documentation
- [API docs]()
- [Changelog](CHANGELOG.md)

## Contributing
Please read the following:

- [Chickenwire style guide](style-guide.md)
- [Chickenwire contribution guide](CONTRIBUTING.md)

before filing issues and/or making contributions.

## Credits
**Dependencies**
- [Bheisler's criterion.rs](https://github.com/bheisler/criterion.rs)
- [Bluss' petgraph](https://github.com/bluss/petgraph)

**Design**
- [Red Blob Games' article](https://www.redblobgames.com/grids/hexagons) on
hexagonal grids

## License
Dual-licensed to be compatible with the Rust project.

This software and associated documentation files are licensed under one of the
following:

- [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
- [MIT License](https://opensource.org/licenses/MIT)

at your option. This file may not be copied, modified, or distributed except
according to those terms.