From 5a12f79f9307ba84c3ebd78d87a3310c81912448 Mon Sep 17 00:00:00 2001
From: Paul-Christian Volkmer <code@pcvolkmer.de>
Date: Fri, 22 Dec 2023 05:03:23 +0100
Subject: [PATCH] docs: explain how to run the example application from source

---
 README.md | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 6e8c49c..c0f5684 100644
--- a/README.md
+++ b/README.md
@@ -56,8 +56,24 @@ client.on_feedback_changed( & cli.room, FeedbackHandler::Sender(tx.clone())).awa
 See [`examples/arsnova-client-tui.rs`](examples/arsnova-client-tui.rs) for a simple terminal-based feedback client
 application.
 
-```bash
-arsnova-client-tui 23269388
+### How to run
+
+```shell
+cargo run --example arsnova-client-tui
+```
+
+```
+Terminal-based ARSnova live feedback client
+
+Usage: arsnova-client-tui [OPTIONS] <ROOM>
+
+Arguments:
+  <ROOM>  Raum
+
+Options:
+  -u, --url <URL>  API-URL [default: https://ars.particify.de/api]
+  -h, --help       Print help
+  -V, --version    Print version
 ```
 
 ![arsnova-client-tui](examples/arsnova-client.gif)
\ No newline at end of file