# weiroll-rs

[![Crates.io](https://img.shields.io/crates/v/weiroll.svg)](https://crates.io/crates/weiroll)
[![Docs.rs](https://docs.rs/weiroll/badge.svg)](https://docs.rs/weiroll)
[![CI](https://github.com/georgewhewell/weiroll-rs/workflows/CI/badge.svg)](https://github.com/georgewhewell/weiroll-rs/actions)

Port of the [weiroll-js](https://github.com/weiroll/weiroll.js) library.

Most features are working (for my use-case) and passing tests.

Missing:
 - [ ] Subplanner support

PR to add support for these features is very welcome!

## Installation

### Cargo

```shell
cargo add weiroll
```

### Usage

Check [examples/example.rs](https://github.com/georgewhewell/weiroll-rs/blob/main/examples/example.rs) or tests in [lib/planner.rs](https://github.com/georgewhewell/weiroll-rs/blob/main/src/planner.rs#L445)

## 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.

See [CONTRIBUTING.md](CONTRIBUTING.md).