From 92a6316d023b9d526ff964a25cf08270899aed86 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sat, 28 Nov 2015 00:01:54 +0100 Subject: improve readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- README | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) (limited to 'README') diff --git a/README b/README index c2aef10..ea25b0a 100644 --- a/README +++ b/README @@ -1,5 +1,16 @@ -Keccak-family hashing library. +NAME + libkeccak - Keccak-family hashing library. -This library implements a lanewise -implementation of the Keccak-family. +DESCRIPTION + libkeccak is a bit-oriented lanewise implementation of + the Keccak-family with support for extend output size, + state marshalling, algorithm tuning with implicit parameters, + secure erasure of sensitive data, and HMAC. + +RATIONALE + Keccak won the SHA-3 competition. We need a library for it, + and let it be bit-oriented. + +SEE ALSO + sha3sum(1), libsha2(7) -- cgit v1.2.3-70-g09d2