From 310ac6cbe4ecd3f26154113207356afdc2050931 Mon Sep 17 00:00:00 2001
From: Jan Starke <jan.starke@telekom.de>
Date: Wed, 23 Aug 2023 15:28:00 +0200
Subject: [PATCH] update documentation for 0.7.3

---
 Cargo.lock           |  4 ++--
 Cargo.toml           |  2 +-
 README.md            | 14 +++++++++++---
 scripts/update-md.sh |  8 ++++++++
 4 files changed, 22 insertions(+), 6 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index 4a28c23..ce17ede 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -681,7 +681,7 @@ dependencies = [
 
 [[package]]
 name = "dfir-toolkit"
-version = "0.7.2"
+version = "0.7.3"
 dependencies = [
  "anyhow",
  "assert-json-diff",
@@ -714,7 +714,7 @@ dependencies = [
  "matches",
  "more-asserts",
  "nt_hive2",
- "num-derive 0.4.0",
+ "num-derive 0.3.3",
  "num-traits",
  "ouroboros",
  "phf",
diff --git a/Cargo.toml b/Cargo.toml
index a1fbccb..fe1919d 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "dfir-toolkit"
-version = "0.7.2"
+version = "0.7.3"
 edition = "2021"
 authors = ["Jan Starke <jan.starke@posteo.de>"]
 description = "CLI tools for digital forensics and incident response"
diff --git a/README.md b/README.md
index 97196a1..feb82b8 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,14 @@
 cargo install dfir-toolkit
 ```
 
+To generate autocompletion scripts for your shell, invoke the tool with the `--autocomplete` option, e.g.
+
+```bash
+mactime2 --autocomplete bash | sudo tee /etc/bash_completion.d/mactime2
+```
+
+would install a autocompletion script in `/etc/bash_completion.d/mactime2`.
+
 # Tools
 # Command-Line Help for `cleanhive`
 
@@ -50,7 +58,7 @@ This document contains the help content for the `cleanhive` command-line program
 
 merges logfiles into a hive file
 
-**Usage:** `cleanhive [OPTIONS] --output <DST_HIVE> <HIVE_FILE>`
+**Usage:** `cleanhive [OPTIONS] <HIVE_FILE>`
 
 ###### **Arguments:**
 
@@ -62,7 +70,8 @@ merges logfiles into a hive file
 * `-v`, `--verbose` — More output per occurrence
 * `-q`, `--quiet` — Less output per occurrence
 * `-O`, `--output <DST_HIVE>` — name of the file to which the cleaned hive will be written
-* `--markdown-help` — print help in markdown format
+
+  Default value: `-`
 
 
 
@@ -531,7 +540,6 @@ CLI tools for digital forensics and incident response
 * `--strict` — strict mode: do not only warn, but abort if an error occurs
 * `-v`, `--verbose` — More output per occurrence
 * `-q`, `--quiet` — Less output per occurrence
-* `--markdown-help` — print help in markdown format
 
 
 
diff --git a/scripts/update-md.sh b/scripts/update-md.sh
index c1e09a3..e9cb88b 100755
--- a/scripts/update-md.sh
+++ b/scripts/update-md.sh
@@ -42,6 +42,14 @@ cat >README.md <<'EOF'
 cargo install dfir-toolkit
 ```
 
+To generate autocompletion scripts for your shell, invoke the tool with the `--autocomplete` option, e.g.
+
+```bash
+mactime2 --autocomplete bash | sudo tee /etc/bash_completion.d/mactime2
+```
+
+would install a autocompletion script in `/etc/bash_completion.d/mactime2`.
+
 # Tools
 EOF