# routefinder

To get started, see [the api docs][docs] or play with [the crate
example](https://github.com/jbr/routefinder/blob/main/examples/cli.rs)
by cloning this repository and running
```
cargo run --example cli /hello/earth
```

* [API Docs][docs] [![docs.rs docs][docs-badge]][docs]
* [Releases][releases] [![crates.io version][version-badge]][crate]
* [Contributing][contributing]
* [CI ![CI][ci-badge]][ci]
* [API docs for main][main-docs]

[ci]: https://github.com/jbr/routefinder/actions?query=workflow%3ACI
[ci-badge]: https://github.com/jbr/routefinder/workflows/CI/badge.svg
[releases]: https://github.com/jbr/routefinder/releases
[docs]: https://docs.rs/routefinder
[contributing]: https://github.com/jbr/routefinder/blob/main/.github/CONTRIBUTING.md
[crate]: https://crates.io/crates/routefinder
[docs-badge]: https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square
[version-badge]: https://img.shields.io/crates/v/routefinder.svg?style=flat-square
[main-docs]: https://jbr.github.io/routefinder/routefinder/

## Safety
This crate uses `#![deny(unsafe_code)]`.

## License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br/>

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