From f6d0572984f78f400166fc585dd3b3a120101647 Mon Sep 17 00:00:00 2001
From: euxane
Date: Sat, 30 Nov 2024 11:44:43 +0100
Subject: cli: turn action and target into positional arguments

---
 readme.md | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
index a105b43..52c8a9e 100644
--- a/readme.md
+++ b/readme.md
@@ -22,13 +22,13 @@ CLI usage
 ```helptext
 tickwatch: A monitoring and visualization tool
 
-Usage: tickwatch [OPTIONS]
+Usage: tickwatch [OPTIONS] MONITOR TARGET
 
-Monitor options:
-  --ping=HOST         Monitor ping latency to specified IP or hostname
-                      Prefix hostname with 4/ or 6/ to force IP version
-  --value=PATH        Monitor a sysfs file's value
-  --change=PATH       Monitor changes in a sysfs file's value
+Monitors:
+  ping                Monitor ping latency to specified IP or hostname
+                      Prefix target hostname with 4/ or 6/ to force IP version
+  value               Monitor a sysfs file's value
+  change              Monitor changes in a sysfs file's value
 
 Display options:
   --range=MIN:MAX     Set range of values (default: 0:1000)
@@ -44,13 +44,13 @@ Other options:
   --version, -v       Display the version
 
 Examples:
-  tickwatch --ping=6/euxane.net
+  tickwatch ping 6/euxane.net
 
   tickwatch --range=0:100000 \
-    --change=/sys/class/net/eth0/statistics/rx_packets
+    change /sys/class/net/eth0/statistics/rx_packets
 
   tickwatch --scale=linear --range=0:50000 \
-    --value=/sys/class/thermal/thermal_zone0/temp
+    value /sys/class/thermal/thermal_zone0/temp
 ```
 
 
-- 
cgit v1.2.3