From 231c8ee7c8e00c8be59596b2e89f0617f2c09145 Mon Sep 17 00:00:00 2001
From: JensDiemer <git@jensdiemer.de>
Date: Tue, 16 Dec 2025 20:35:22 +0100
Subject: [PATCH] Update README

---
 README.md                          | 23 ++++++++++++++++++++++-
 dwload_server/tests/test_readme.py | 15 +++++++++++++++
 2 files changed, 37 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 141a02e..b8fccd8 100644
--- a/README.md
+++ b/README.md
@@ -12,8 +12,28 @@ Connect your Dragon 32 into your PC and LOAD/SAVE basic listings.
 ```bash
 ~$ git clone https://github.com/6809/DwLoadServer.git
 ~$ cd DwLoadServer
-~/DwLoadServer$ ./devshell.py run serial
+~/DwLoadServer$ ./cli.py run --help
+```
+
+The help page looks like:
+
+[comment]: <> (✂✂✂ auto generated run help start ✂✂✂)
+```
+usage: ./cli.py run [-h] [RUN OPTIONS]
+
+Start the DWLOAD server.
+
+╭─ options ────────────────────────────────────────────────────────────────────────╮
+│ -h, --help         show this help message and exit                               │
+│ --root-dir PATH    Root path for dwload files (default: /home/jens/dwload-files) │
+│ --interface STR    Use interface: "becker" or "serial" (default: becker)         │
+│ --ip STR           IP address for the interface (default: 127.0.0.1)             │
+│ --port INT         Port number (default: 65504)                                  │
+│ --serial-port STR  Serial port for serial interface (default: /dev/ttyUSB0)      │
+│ -v, --verbosity    Verbosity level; e.g.: -v, -vv, -vvv, etc. (repeatable)       │
+╰──────────────────────────────────────────────────────────────────────────────────╯
 ```
+[comment]: <> (✂✂✂ auto generated run help end ✂✂✂)
 
 
 ## features
@@ -221,6 +241,7 @@ usage: ./dev-cli.py [-h] {coverage,install,lint,mypy,nox,pip-audit,publish,test,
 [comment]: <> (✂✂✂ auto generated history start ✂✂✂)
 
 * [v0.6.0](https://github.com/6809/DwLoadServer/compare/v0.5.1...v0.6.0)
+  * 2025-12-16 - Update README
   * 2025-12-16 - Migrate to UV
   * 2023-09-24 - Update requirements
 * [v0.5.1](https://github.com/6809/DwLoadServer/compare/v0.5.0...v0.5.1)
diff --git a/dwload_server/tests/test_readme.py b/dwload_server/tests/test_readme.py
index 0818854..f7ff1b7 100644
--- a/dwload_server/tests/test_readme.py
+++ b/dwload_server/tests/test_readme.py
@@ -37,6 +37,21 @@ def test_main_help(self):
         )
         assert_cli_help_in_readme(text_block=stdout, marker='main help')
 
+    def test_run_help(self):
+        with NoColorEnvRich():
+            stdout = invoke(cli_bin=PACKAGE_ROOT / 'cli.py', args=['run', '--help'], strip_line_prefix='usage: ')
+        self.assert_in_content(
+            got=stdout,
+            parts=(
+                'usage: ./cli.py run [-h] [RUN OPTIONS]',
+                'interface',
+                'becker',
+                'serial',
+                'Start the DWLOAD server.',
+            ),
+        )
+        assert_cli_help_in_readme(text_block=stdout, marker='run help')
+
     def test_dev_help(self):
         with NoColorEnvRich():
             stdout = invoke(cli_bin=PACKAGE_ROOT / 'dev-cli.py', args=['--help'], strip_line_prefix='usage: ')