Merge pull request #14 from triarius/triarius/update-docs

Update docs with --no-header option
triarius · Sep 22, 2024 · 5b80a4a · 5b80a4a
2 parents 5f682a8 + da4e8b2
commit 5b80a4a
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -16,6 +16,7 @@ Options:
   -i, --in-file <IN_FILE>    The file to log stdin to [env: IN_FILE=]
   -o, --out-file <OUT_FILE>  The file to log stdout to [env: OUT_FILE=]
   -e, --err-file <ERR_FILE>  The file to log stderr to [env: ERR_FILE=]
+      --no-header            Whether to write a header to the log file(s) [env: NO_HEADER=]
   -h, --help                 Print help
   -V, --version              Print version
 ```
diff --git a/src/main.rs b/src/main.rs
@@ -18,6 +18,7 @@ struct Args {
     #[arg(short, long, env)]
     err_file: Option<PathBuf>,
 
+    /// Whether to write a header to the log file(s).
     #[arg(long, env)]
     no_header: bool,