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

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

a collection of geometry and graph based utilities with emphasis on simple code and readability.

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

This project is a collection of utilities to help you generate new and exciting words that vaguely resemble the English language.
Support is provided for simple letter sampling, digraph sampling, word generation and much more. No more will you need to import a list of names into your project- simply generate a new one on the fly!

<!-- 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
* [`words`] - adds functionality for building whole words.
* [`nouns`] - provides a constructor for propper nouns.


## 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/prima](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 1.56]: 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/"