diff options
author | Mattias Andrée <maandree@operamail.com> | 2013-02-09 10:28:13 +0100 |
---|---|---|
committer | Mattias Andrée <maandree@operamail.com> | 2013-02-09 10:28:13 +0100 |
commit | 28fef478d7813eda40aa304baa33f07981002010 (patch) | |
tree | 802be467e6decdeac853a6f62136a854139e8736 /README.md | |
parent | there is a chance I will also implement in common lisp and scala (diff) | |
download | sha3sum-28fef478d7813eda40aa304baa33f07981002010.tar.gz sha3sum-28fef478d7813eda40aa304baa33f07981002010.tar.bz2 sha3sum-28fef478d7813eda40aa304baa33f07981002010.tar.xz |
use markdown on readme
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
-rw-r--r-- | README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..10e29c1 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +COMPLETE STATUS: + + Pure Java 1.2+ :: optimised + Python 3 :: optimised + C ISO C90 :: optimised + Java/C JNI :: under development + NASM :: planned (maybe, after jni) + Haskell :: planned (maybe) + Python 2 :: planned (maybe) + Perl :: planned (maybe) + Common Lisp :: planned (perhaps) + Scala :: planned (perhaps) + + +**SHA-3/Keccak checksum calculator** + +*USAGE:* + + sha3sum [option...] < FILE + sha3sum [option...] file... + +*OPTIONS:* + + -r BITRATE + --bitrate The bitrate to use for SHA-3. (default: 576) + + -c CAPACITY + --capacity The capacity to use for SHA-3. (default: 1024) + + -w WORDSIZE + --wordsize The word size to use for SHA-3. (default: 64) + + -o OUTPUTSIZE + --outputsize The output size to use for SHA-3. (default: 512) + + -s STATESIZE + --statesize The state size to use for SHA-3. (default: 1600) + + -i ITERATIONS + --iterations The number of hash iterations to run. (default: 1) + + -b + --binary Print the checksum in binary, rather than hexadecimal. + |