# WordLists

Current Release: 0.2.0

[![License](https://img.shields.io/crates/l/wordlists.svg)](https://choosealicense.com/licenses/mit/)
[![builds.sr.ht status](https://builds.sr.ht/~dstar4138/wordlists-rs.svg)](https://sr.ht/~dstar4138/wordlists-rs)
[![Latest version](https://img.shields.io/crates/v/wordlists.svg)](https://crates.io/crates/wordlists)
[![Documentation](https://docs.rs/wordlists/badge.svg)](https://docs.rs/wordlists)

This package encodes a number of wordlists behind a somewhat unified interface. This interface is useful for:

* Encoding binary data as a wordlist.
* Encoding a UUID or number as a wordlist.
* Generating a random wordlist.
* Take a Wordlist and generate the binary from it.
* Validate binary given a wordlist.
* Confirm if a wordlist comes from a specific generator.

Utility of this package; while it has a number of sub-implementations, each is gated by a feature-flag.

## Note on the package name...

I don't know what to call this package; but this is a package of word-lists, so that's what I called it. However,
there is a squat-on package called 'wordlist', so there may eventually be issues here.

### Alternatives

There are a lot of packages which encode "a wordlist" already, such as:
[eff-wordlist][effwordlist], [diceware][diceware], [chbs][chbs], among others.
They are probably better than this package.

[effwordlist]: https://crates.io/crates/eff-wordlist
[diceware]: https://crates.io/crates/diceware
[chbs]: https://crates.io/crates/chbs