# token-iter

[![Crates.io](https://img.shields.io/crates/v/token-iter.svg)](https://crates.io/crates/token-iter)
[![Docs.rs](https://docs.rs/token-iter/badge.svg)](https://docs.rs/token-iter)
[![CI](https://github.com/NicholasSterling/token-iter/workflows/CI/badge.svg)](https://github.com/NicholasSterling/token-iter/actions)
[![Coverage Status](https://coveralls.io/repos/github/NicholasSterling/token-iter/badge.svg?branch=main)](https://coveralls.io/github/NicholasSterling/token-iter?branch=main)

A Rust library crate that facilitates writing tokenizers for textual languages.

Please read the [API documentation here](https://docs.rs/token-iter/).

To use it, add this to your `Cargo.toml`:

```toml
[dependencies]
token-iter = "0.10.0"
```

And put this in your code:

```rust
use token_iter::*;
```

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

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