From 7c89cded145b39c0cf3680034a0ae236a67253ff Mon Sep 17 00:00:00 2001 From: lukechampine Date: Thu, 9 Jan 2020 23:09:57 -0500 Subject: [PATCH] update README --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0406f65..f426db0 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,9 @@ go get lukechampine.com/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 -has not been optimized for performance, and is not written in idiomatic Go -style. I may clean it up later and optimize it to some degree, but don't expect -good performance until someone writes an assembly version. +This implementation is a port of the Rust reference implementation, refactored +into more idiomatic Go style and with a handful of performance tweaks. +Performance is not great, not terrible. Eventually an assembly-optimized +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.