# RingChannel [![docs.badge]][docs.home] [![codecov.badge]][codecov.home]

Bounded MPMC channel abstraction on top of a ring buffer.

## Using RingChannel

RingChannel is available on [crates.io], simply add it as a dependency in your `Cargo.toml`:

```
[dependencies]
ring-channel = "0.12"
```

The full API documentation is available on [docs.rs][docs.home]

## Contribution

RingChannel is an open source project and you're very welcome to contribute to this project by
opening [issues] and/or [pull requests][pulls], see [CONTRIBUTING][CONTRIBUTING] for general
guidelines.

## License

RingChannel is distributed under the terms of the MIT license, see [LICENSE] for details.

[crates.io]:        https://crates.io/crates/ring-channel

[docs.home]:        https://docs.rs/ring-channel
[docs.badge]:       https://docs.rs/ring-channel/badge.svg

[codecov.home]:     https://codecov.io/gh/brunocodutra/ring-channel
[codecov.badge]:    https://codecov.io/gh/brunocodutra/ring-channel/branch/master/graph/badge.svg

[issues]:           https://github.com/brunocodutra/ring-channel/issues
[pulls]:            https://github.com/brunocodutra/ring-channel/pulls

[LICENSE]:          https://github.com/brunocodutra/ring-channel/blob/master/LICENSE
[CONTRIBUTING]:     https://github.com/brunocodutra/ring-channel/blob/master/CONTRIBUTING.md