aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ec23b69
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+sha3sum
+=======
+
+Simple program to expose `golang.org/x/crypto/sha3` on the command line (similar to the `sha1sum` utility)
+
+Usage
+-----
+
+Call the program with a list of filenames, these will be hashed. The filename '-' represents stdin. When no argument is passed, hash stdin. Optionally you can specify the hash size (e.g. 256, 512) with the optional `-algo` flag. See `sha3sum -help`.