aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-11-28 00:21:42 +0100
committerMattias Andrée <maandree@operamail.com>2015-11-28 00:21:42 +0100
commitb2a99ddbfacf3c9f5d0c7541184a0a8931ceab5e (patch)
treec10f1a2df120582e7a3caef69da3f6b0ac02ed83
parenttypo (diff)
downloadlibsha2-b2a99ddbfacf3c9f5d0c7541184a0a8931ceab5e.tar.gz
libsha2-b2a99ddbfacf3c9f5d0c7541184a0a8931ceab5e.tar.bz2
libsha2-b2a99ddbfacf3c9f5d0c7541184a0a8931ceab5e.tar.xz
improve readme
Signed-off-by: Mattias Andrée <maandree@operamail.com>
-rw-r--r--README15
1 files changed, 14 insertions, 1 deletions
diff --git a/README b/README
index cf72d7a..392e533 100644
--- a/README
+++ b/README
@@ -1,2 +1,15 @@
-SHA-2-family hashing library.
+NAME
+ libsha2 - SHA-2-family hashing library
+
+DESCRIPTION
+ libsha2 is a bit-oriented implementation of the SHA2-family
+ with support for SHA-224, SHA-256, SHA-384, SHA-512,
+ SHA-512/224, and SHA-512/256, state marshalling, secure
+ erasure of sensitive data, and HMAC.
+
+RATIONALE
+ This should be obvious.
+
+SEE ALSO
+ libkeccak(7), sha224sum(1), sha256sum(1), sha384sum(1), sha512sum(1)