summaryrefslogtreecommitdiffstats
path: root/desktop/xob/README
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/xob/README')
-rw-r--r--desktop/xob/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/desktop/xob/README b/desktop/xob/README
new file mode 100644
index 0000000000..7e1720fb57
--- /dev/null
+++ b/desktop/xob/README
@@ -0,0 +1,9 @@
+xob - X Overlay Bar
+
+A lightweight configurable overlay volume/backlight/progress/anything
+bar for the X Window System (and Wayland compositors with XWayland).
+Each time a new value is read on the standard input, it is displayed as
+a tv-like bar over other windows. It then vanishes after a configurable
+amount of time. A value followed by a bang '!' is displayed using an
+alternate color to account for special states (e.g. muted audio). There
+is also support for overflows (when the value exceeds the maximum).