docs: add CLI example to README

Author: foosel

README.md

@@ -35,6 +35,7 @@ See `gcode_thumbnail_tool.py:main` and `tests/test_api.py` for more usage exampl
 <!--INSERT:help-->
 
 ```
+$ gcode-thumbnail-tool
 usage: gcode-thumbnail-tool [-h] [--verbose] {extract,analyse} ...
 
 A small CLI tool to extract thumbnail images from GCODE files.
@@ -56,6 +57,7 @@ options:
 <!--INSERT:extract-->
 
 ```
+$ gcode-thumbnail-tool extract --help
 usage: gcode-thumbnail-tool extract [-h] [-o OUTPUT] path
 
 positional arguments:
@@ -74,6 +76,7 @@ options:
 <!--INSERT:analyse-->
 
 ```
+$ gcode-thumbnail-tool analyse --help
 usage: gcode-thumbnail-tool analyse [-h] path
 
 positional arguments:
@@ -85,6 +88,21 @@ options:
 
 <!--/INSERT:analyse-->
 
+#### Example
+
+<!--INSERT:example-->
+
+```
+$ gcode-thumbnail-tool analyse tests/_files/prusa_2.9.3.gcode
+Found 4 thumbnails in tests/_files/prusa_2.9.3.gcode, in format "generic":
+	PNG @ 16x16
+	PNG @ 220x124
+	QOI @ 64x64
+	JPEG @ 64x64
+```
+
+<!--/INSERT:example-->
+
 ## Acknowledgements
 
 `gcode-thumbnail-tool` is based on the [Slicer Thumbnails OctoPrint Plugin](https://github.com/jneilliii/OctoPrint-PrusaSlicerThumbnails) by jneilliii.

Taskfile.yml

@@ -4,25 +4,40 @@ tasks:
   update-readme:
     cmds:
       - |
-        help_output=$(gcode-thumbnail-tool)
-        extract_output=$(gcode-thumbnail-tool extract --help)
-        analyse_output=$(gcode-thumbnail-tool analyse --help)
+        help_command="gcode-thumbnail-tool"
+        help_output=$($help_command)
 
-        awk -i inplace -v text="$help_output" '
+        extract_command="gcode-thumbnail-tool extract --help"
+        extract_output=$($extract_command)
+
+        analyse_command="gcode-thumbnail-tool analyse --help"
+        analyse_output=$($analyse_command)
+
+        example_command="gcode-thumbnail-tool analyse tests/_files/prusa_2.9.3.gcode"
+        example_output=$($example_command)
+
+        awk -i inplace -v command="$help_command" -v output="$help_output" '
           BEGIN{p=1}
           $1=="<!--INSERT:help-->"{p=0;print;next}
-          $1=="<!--/INSERT:help-->"{print "```\n" text "\n```"; p=1}
+          $1=="<!--/INSERT:help-->"{print "```\n$ " command "\n" output "\n```"; p=1}
           p
         ' README.md
-        awk -i inplace -v text="$extract_output" '
+        awk -i inplace -v command="$extract_command" -v output="$extract_output" '
           BEGIN{p=1}
           $1=="<!--INSERT:extract-->"{p=0;print;next}
-          $1=="<!--/INSERT:extract-->"{print "```\n" text "\n```"; p=1}
+          $1=="<!--/INSERT:extract-->"{print "```\n$ " command "\n" output "\n```"; p=1}
           p
         ' README.md
-        awk -i inplace -v text="$analyse_output" '
+        awk -i inplace -v command="$analyse_command" -v output="$analyse_output" '
           BEGIN{p=1}
           $1=="<!--INSERT:analyse-->"{p=0;print;next}
-          $1=="<!--/INSERT:analyse-->"{print "```\n" text "\n```"; p=1}
+          $1=="<!--/INSERT:analyse-->"{print "```\n$ " command "\n" output "\n```"; p=1}
+          p
+        ' README.md
+
+        awk -i inplace -v command="$example_command" -v output="$example_output" '
+          BEGIN{p=1}
+          $1=="<!--INSERT:example-->"{p=0;print;next}
+          $1=="<!--/INSERT:example-->"{print "```\n$ " command "\n" output "\n```"; p=1}
           p
         ' README.md