Better explanations for config example

README.md

@@ -66,10 +66,10 @@ Open `config.yaml` and at minimum set your broker address and credentials:
 mqtt:
   host: "192.168.1.x"    # your MQTT broker IP or hostname
   port: 1883
-  username: "your_user"
-  password: "your_password"
-  topic_prefix: "monitor-py"
-  client_id: ""           # auto-generated if left empty
+  username: "your_user"          # leave empty if broker has no auth
+  password: "your_password"      # leave empty if broker has no auth
+  topic_prefix: "monitor-py"     # base topic: {topic_prefix}/{node_id}/...
+  client_id: ""           # auto-generated from hostname if left empty
 
 monitor:
   interval: 30            # seconds between publishes
@@ -78,17 +78,17 @@ monitor:
 
 sensors:
   cpu: true
-  gpu: true
+  gpu: true               # NVIDIA via nvidia-smi; skipped gracefully if unavailable
   ram: true
   disk:
     enabled: true
     partitions: []        # empty = auto-detect; or list specific mounts: ["/", "/home"]
-    io_stats: true
+    io_stats: true        # enable read/write speed sensors
   network:
     enabled: true
     interfaces: []        # empty = all non-loopback; or list specific: ["enp6s0"]
-  system: true
-  idle_time: true
+  system: true            # uptime, logged-in users
+  idle_time: true         # session idle via xprintidle (requires X11 + xprintidle in PATH)
 ```
 
 #### `device_name` vs `node_id`

config.yaml.example

@@ -1,15 +1,15 @@
 mqtt:
-  host: ""        # MQTT broker address
+  host: "192.168.1.x"    # your MQTT broker IP or hostname
   port: 1883
-  username: ""               # leave empty if broker has no auth
-  password: ""
-  topic_prefix: "monitor-py" # base topic: {topic_prefix}/{hostname}/...
-  client_id: ""              # leave empty to auto-generate from hostname
+  username: "your_user"          # leave empty if broker has no auth
+  password: "your_password"      # leave empty if broker has no auth
+  topic_prefix: "monitor-py"     # base topic: {topic_prefix}/{node_id}/...
+  client_id: ""           # auto-generated from hostname if left empty
 
 monitor:
-  interval: 15               # seconds between stat publishes
-  device_name: ""            # display name in HA; defaults to hostname
-  node_id: ""                # MQTT topic slug and unique_id prefix; defaults to hostname if empty
+  interval: 30            # seconds between publishes
+  device_name: ""         # human-readable HA device name; defaults to hostname
+  node_id: ""             # MQTT topic slug; defaults to hostname if empty
 
 sensors:
   cpu: true
@@ -17,10 +17,10 @@ sensors:
   ram: true
   disk:
     enabled: true
-    partitions: ["/","/boot"]           # empty = auto-detect all physical, non-loop mounts
+    partitions: []        # empty = auto-detect; or list specific mounts: ["/", "/home"]
     io_stats: true        # enable read/write speed sensors
   network:
     enabled: true
-    interfaces: ["enp6s0","wlan0"]           # empty = all non-loopback interfaces
+    interfaces: []        # empty = all non-loopback; or list specific: ["enp6s0"]
   system: true            # uptime, logged-in users
   idle_time: true         # session idle via xprintidle (requires X11 + xprintidle in PATH)