From 55bf6686df2ac0b738945d85f3305d42df65d4bd Mon Sep 17 00:00:00 2001
From: Daniele Fognini <dfogni@gmail.com>
Date: Sat, 25 Jan 2025 21:59:32 +0000
Subject: [PATCH] add readme from output of --help

---
 README.txt | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.txt

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..2f125b8
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,27 @@
+Pipe through standard input while highlighting and keeping track of delays between lines
+
+Usage: txt-timer [OPTIONS]
+
+Options:
+  -q, --quiet
+          do not output stdin
+  -c, --count <COUNT>
+          number of top differences to print at the end [default: 5]
+  -B, --lines-before <LINES_BEFORE>
+          [default: 5]
+      --color
+          colorized output
+      --color-range <COLOR_RANGE>
+          range for color scale of delay, in seconds [default: 0.2]
+      --time-regex <TIME_REGEX>
+          use regex to extract timestamp from lines instead of using real time, must have one (?<time> ) named capturing group
+      --time-regex-format <TIME_REGEX_FORMAT>
+          format of timestamp, without timezone see `strftime`. Example `%Y-%m-%d %H:%M:%S%.3f`
+  -p, --prepend-time
+          prepend time to output
+  -o, --output-maximals <OUTPUT_MAXIMALS>
+          redirect output of maximum differences to a file
+      --async-buffer-line-count <ASYNC_BUFFER_LINE_COUNT>
+          buffer size for asynchronous processing [default: 128]
+  -h, --help
+          Print help (see more with '--help')