xxHash Specifications
=====================

This directory contains documentation and reference material for the xxHash
family of hash algorithms:

- [xxhash_spec.md](xxhash_spec.md) specifies XXH32, XXH64, and XXH3.
- [xxhash.cry](xxhash.cry) provides executable Cryptol specifications of XXH32
  and XXH64.

For readable implementations of these algorithms, see the
[xxhash-clean](https://github.com/easyaspi314/xxhash-clean) educational library,
written by [@easyaspi314](https://github.com/easyaspi314). That project
prioritizes readability, while the reference implementation in this repository
prioritizes speed.