Squash merge set-max-volume into master

1 files changed, 27 insertions, 0 deletions

diff --git a/README.md b/README.md
index da3fe4c..4733405 100644
--- a/README.md
+++ b/README.md
@@ -57,6 +57,33 @@ href="dwl-config.h.patch">dwl-config.h.patch</a></dd>
      point to its absolute location. </li>
 </ul>
 
+Environment variables
+---------------------
+
+You can set the `SWOB_MAX_VOLUME` environment variable to set the maximum volume.
+
+```conf
+# Your Sway config
+
+set $SWOB_MAX_VOLUME 120
+
+bindsym --locked XF86AudioLowerVolume exec exec env SWOB_MAX_VOLUME=$SWOB_MAX_VOLUME swob.sh volume 5%-
+bindsym --locked XF86AudioRaiseVolume exec exec env SWOB_MAX_VOLUME=$SWOB_MAX_VOLUME swob.sh volume 5%+
+```
+
+Theming
+-------
+
+For wob styling when the value is above the threshold, there are styles: `overflow_bar_color`, `overflow_background_color`, `overflow_border_color`.
+
+```ini
+[style.mute]
+background_color = af0000
+background_color = af0000
+overflow_bar_color = FF5555
+overflow_border_color = 000000
+```
+
 Copying
 -------