# Engish
<div id="top"></div>

[![Latest Version]][crates.io] 
[![docs]][docs.rs]
[![Minimum Supported Rust Version]][Rust]

A strongly opinionated crate that supports messing around with language (in ways you probably shouldn't). 

<!-- ABOUT THE PROJECT -->
## About The Project

This project serves two purposes- easy handling of words within the framework of a language and word generation. The majority of the given 
frameworks apply predominantly to the English language but can be adapted for others.

<!-- GETTING STARTED -->
## Getting Started

As with most rust crates, this can be imported to a project using [crates.io](https://crates.io/crates). Follow the link for more infomation.

### Optional features
* [`builders`] - adds functionality for word building.


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

Contributions are both welcome and appreciated!

Contributions in any form (issues, pull requests, etc.) to this project must
adhere to Rust's [Code of Conduct].

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.

<!-- CONTACT -->
## Contact

Caspar Green - caspar.m.green@gmail.com

Project Link: [https://github.com/fishykins/engish](https://github.com/fishykins/engish)

<p align="right">(<a href="#top">back to top</a>)</p>


<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[Latest Version]: https://img.shields.io/crates/v/engish.svg
[crates.io]: https://crates.io/crates/engish/
[Minimum Supported Rust Version]: https://img.shields.io/badge/Rust-1.56.0-blue?color=fc8d62&logo=rust
[Rust]: https://github.com/rust-lang/rust/blob/master/RELEASES.md#version-1560-2021-10-21
[Code of Conduct]: https://www.rust-lang.org/en-US/conduct.html
[docs]: "https://img.shields.io/docsrs/engish/"
[docs.rs]: "https://docs.rs/prima/latest/engish/"