aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Duncan <pabs@pablotron.org>2019-08-25 08:02:56 -0400
committerPaul Duncan <pabs@pablotron.org>2019-08-25 08:02:56 -0400
commit03d69860794a85c49d93e987b0aa3fc838ce6812 (patch)
treecba017c851fad9a4edaf985579ecc24c2a1dd68d
parent39eba72693834f84c2da7c5242435e5738a35d67 (diff)
downloadsha2-master.tar.bz2
sha2-master.zip
add Features and link to test vectors to READMEHEADmaster
-rw-r--r--README.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/README.md b/README.md
index 20f5245..93b0324 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,11 @@
Self-contained [C11][] [SHA-2][] implementation.
+Features:
+* Self-contained (no external dependencies)
+* C11 only (platform-agnostic)
+* MIT-licensed
+* Includes [test vectors][] (via `make test`)
+
Includes implementations of the following:
* SHA-224
* SHA-256
@@ -8,15 +14,19 @@ Includes implementations of the following:
* HMAC-SHA-256
* HMAC-SHA-512
+Usage
+-----
See `tests.c` for usage.
+Use `make test` to run the [test vectors][].
+
Benchmarks
-==========
+----------
Benchmarks.
Partially unrolled compression makes this implementation faster than
-[coreutils][], but slower than the [assembly-optimized, family-specific
-OpenSSL SHA-2 implementation][openssl-asm-sha].
+[coreutils][], but slower than the [assembly-optimized, architecture and
+family-specific OpenSSL implementation][openssl-asm-sha].
```
> time -p ./sha256 ~/Videos/8x*avi > /dev/null
@@ -37,3 +47,4 @@ sys 0.32
[c11]: https://en.wikipedia.org/wiki/C11_(C_standard_revision) "C11 standard of the C programming language"
[coreutils]: https://www.gnu.org/software/coreutils/ "GNU core utilities"
[openssl-asm-sha]: https://github.com/openssl/openssl/tree/master/crypto/sha/asm "assembly-optimized OpenSSL SHA-2 implementation."
+ [test vectors]: https://www.di-mgt.com.au/sha_testvectors.html "SHA test vectors."