update README

This commit is contained in:
lukechampine 2020-01-09 23:09:57 -05:00
parent bc09571efd
commit 7c89cded14
1 changed files with 6 additions and 4 deletions

View File

@ -10,7 +10,9 @@ go get lukechampine.com/blake3
`blake3` implements the [BLAKE3 cryptographic hash function](https://github.com/BLAKE3-team/BLAKE3). `blake3` implements the [BLAKE3 cryptographic hash function](https://github.com/BLAKE3-team/BLAKE3).
This implementation is a direct port of the Rust reference implementation. It This implementation is a port of the Rust reference implementation, refactored
has not been optimized for performance, and is not written in idiomatic Go into more idiomatic Go style and with a handful of performance tweaks.
style. I may clean it up later and optimize it to some degree, but don't expect Performance is not great, not terrible. Eventually an assembly-optimized
good performance until someone writes an assembly version. implementation will be merged into `x/crypto`, and then you should switch to
that. In the meantime, you can use this package for code that needs BLAKE3
compatibility and doesn't need to be blazing fast.