summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Duncan <pabs@pablotron.org>2024-03-02 19:30:10 -0500
committerPaul Duncan <pabs@pablotron.org>2024-03-02 19:30:10 -0500
commitf01678386ff2e709edc03c213f70418ec1ba807c (patch)
tree5d50d5b22b86fc8115e6c24a4f64417d5405e465
parentcdda5cdbd834691db90c1d5238080f4369c88d9f (diff)
downloadsha3-0.6.tar.bz2
sha3-0.6.zip
README.md: move hmac down in list of algorithms, add note about recommended compiler flagsv0.6
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index 620dc1c..c44be99 100644
--- a/README.md
+++ b/README.md
@@ -18,10 +18,10 @@ The following algorithms are implemented:
* SHA3-224, SHA3-256, SHA3-384, and SHA3-512: [SHA-3][] [cryptographic
hash functions][hash], as defined in section 6.1 of [FIPS 202][].
+* SHAKE128 and SHAKE256: [XOFs][xof] as defined in section 6.2 of [FIPS 202][].
* HMAC-SHA3-224, HMAC-SHA3-256, HMAC-SHA3-384, HMAC-SHA3-512:
[HMAC][hmac] instantiated with [SHA-3][] hash functions, as specified
in section 7 of [FIPS 202][], [RFC 2104][], and [FIPS 198-1][].
-* SHAKE128 and SHAKE256: [XOFs][xof] as defined in section 6.2 of [FIPS 202][].
* cSHAKE128, cSHAKE128-XOF, cSHAKE256, and cSHAKE256-XOF: Fixed-length
and [XOF][] variants of the customizable-SHAKE primitive, as defined
in section 3 of [SP 800-185][800-185].
@@ -175,6 +175,9 @@ To use this library in your application:
2. Update your build system to compile `sha3.o`.
3. Include `sha3.h` in your application.
+See the top-level `Makefile` and the examples for recommended
+compiler flags.
+
## Documentation
Full [API][] documentation is available online [here][api-docs] and in