From 188e138185a642bf14fa11f2815666fc096bbd45 Mon Sep 17 00:00:00 2001
From: Ben Boyter <ben@boyter.org>
Date: Thu, 28 Jul 2022 13:57:09 +1000
Subject: [PATCH] tweak readme

---
 README.md | 25 +++++++++++++++++++++----
 go.sum    |  1 -
 2 files changed, 21 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 63412ba..6242d22 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,7 @@ Full details can be found in `hashit --help` or `hashit -h`.
 ```
 $ hashit -h
 Hash It!
+Version 1.1.0
 Ben Boyter <ben@boyter.org>
 
 Usage:
@@ -56,8 +57,10 @@ Flags:
   -h, --help              help for hashit
       --no-stream         do not stream out results as processed
   -o, --output string     output filename (default stdout)
+  -p, --progress          display progress of files as they are processed
   -r, --recursive         recursive subdirectories are traversed
       --stream-size int   min size of file in bytes where stream processing starts (default 1000000)
+      --threads int       number of threads processing files, by default the number of CPU cores (default 8)
       --trace             enable trace output
   -v, --verbose           verbose output
       --version           version for hashit
@@ -155,19 +158,33 @@ README.md (7094 bytes)
 ... OUTPUT SNIPPED ...
 ```
 
+If you are running hashit on a slower mechanical HDD you may want to limit the number of threads which read files from
+disk using `--threads 1`
+
+```shell
+$ hashit --threads 1 /mnt/slowdisk/
+```
+
+For large files you can use `-p` to see the progress of the file to get an idea of how long it might take to process.
+
+```shell
+$ hashit -p --threads 1 large.file
+[==================================>---------------------------------] file: large.file
+```
 
-#### Misc stuff below
 
-Examples of SUM's
+#### Misc stuff below
 
-http://releases.ubuntu.com/16.04/MD5SUMS
-http://releases.ubuntu.com/16.04/SHA1SUMS
+Usage of hashdeep
 
 https://linhost.info/2010/05/using-hashdeep-to-ensure-data-integrity/
 
+Issues to address
 
 https://github.com/jessek/hashdeep/issues/4
 https://github.com/jessek/hashdeep/issues/358
 
+Example usage
+
 hashdeep -r vendor > audit.txt
 hashdeep -r -a -k audit.txt vendor
diff --git a/go.sum b/go.sum
index 0e3fce0..5e55694 100644
--- a/go.sum
+++ b/go.sum
@@ -24,7 +24,6 @@ golang.org/x/crypto v0.0.0-20190513172903-22d7a77e9e5f/go.mod h1:yigFU9vqHzYiE8U
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20201014080544-cc95f250f6bc h1:HVFDs9bKvTxP6bh1Rj9MCSo+UmafQtI8ZWDPVwVk9g4=
 golang.org/x/sys v0.0.0-20201014080544-cc95f250f6bc/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I=
 golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=