added doc to config

config.yaml

@@ -1,12 +0,0 @@
-bandwidth:
-  min: 2
-  max: 45
-  step: 1
-interval: 30
-host: "itsh.dev"
-ppp: 5
-conformation_ppp: 30
-log_level: DEBUG
-upload_interface: "enp1s0f1"
-throttle_ping_threshold: 50
-try_restoring_after: 30

config_sample.yaml

@@ -0,0 +1,20 @@
+log_level: DEBUG
+# bandwidth limits in MBit
+bandwidth:
+  min: 2
+  max: 45
+  step: 1
+# interval in seconds to check ping
+interval: 30
+# host to ping to
+host: "google.com"
+# packages per ping (short)
+ppp: 5
+# packages per ping (long)
+conformation_ppp: 30
+# interface to change qdisc on
+upload_interface: "enp1s0f1"
+# ping threshold (anything above this causes throttling)
+throttle_ping_threshold: 50
+# minutes delay from an above-threshold moment to try increasing bandwidth again
+try_restoring_after: 30