From f01678386ff2e709edc03c213f70418ec1ba807c Mon Sep 17 00:00:00 2001 From: Paul Duncan Date: Sat, 2 Mar 2024 19:30:10 -0500 Subject: README.md: move hmac down in list of algorithms, add note about recommended compiler flags --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'README.md') 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 -- cgit v1.2.3