aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2024-08-30 17:20:30 +0200
committerMattias Andrée <maandree@kth.se>2024-08-30 17:20:30 +0200
commit87437d71b36518dac5086f8cc92480935e4cf60b (patch)
tree8cabd9b8871320216d371aa7c0e8774fd06d91f4 /README
parentm + add support for z parameter for keccak (diff)
downloadlibhashsum-87437d71b36518dac5086f8cc92480935e4cf60b.tar.gz
libhashsum-87437d71b36518dac5086f8cc92480935e4cf60b.tar.bz2
libhashsum-87437d71b36518dac5086f8cc92480935e4cf60b.tar.xz
m + add man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'README')
-rw-r--r--README23
1 files changed, 12 insertions, 11 deletions
diff --git a/README b/README
index 7e06f52..1ee0242 100644
--- a/README
+++ b/README
@@ -1,9 +1,9 @@
NAME
- libhashsum - Library for calculating the cryptographic hashes
+ libhashsum - library for calculating the cryptographic hashes
DESCRIPTION
- libhashsum provides a unified interface for several
- cryptographic hash functions. Currently supported
+ The libhashsum library provides a unified interface for
+ several cryptographic hash functions. Currently supported
hash functions are:
Built in
@@ -11,17 +11,17 @@ DESCRIPTION
RIPEMD-320
Via libsha1
- SHA0, SHA1
+ SHA-0, SHA-1
Via libsha2
SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224,
SHA-512/256
Via libkeccak>=1.3
- Keccak[], Keccak-224, Keccak-256, Keccak-384,
- Keccak-512, SHA3-224, SHA3-256, SHA3-384, SHA3-512,
- SHAKE128, SHAKE256, SHAKE512, RawSHAKE128,
- RawSHAKE256, RawSHAKE512
+ Keccak, Keccak-224, Keccak-256, Keccak-384,
+ Keccak-512, SHA-3-224, SHA-3-256, SHA-3-384,
+ SHA-3-512, SHAKE128, SHAKE256, SHAKE512,
+ RawSHAKE128, RawSHAKE256, RawSHAKE512
Via libblake>=1.1
BLAKE224, BLAKE256, BLAKE384, BLAKE512
@@ -34,6 +34,7 @@ DESCRIPTION
hash function. It also have a function that can parse
a string describing any support function with its
parameters. For hash function that do not require
- any parameters, it has a function that can select
- the appropriate initialiser based on an enum value
- that specifies the algorithm.
+ any parameters, or only have optional parameters with
+ obvious default values, it has a function that can
+ select the appropriate initialiser based on an enum
+ value that specifies the algorithm.