aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7a7adb0..6e0701c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,18 @@
# bspswallow
-dwm-like swallowing for bspwm
+Adds functionality provided by the dwm "swallow" patch to bspwm.
+
+# Instalation
+Add two files to ~/.config/bspwm
+
+swallow - list of classes of windows that you want to swallow the terminal
+terminals - list of classes of terminals that you want to be swallowed
+
+example files are included in "examples".
+
+Place bspswallow into your PATH and add the following line to your bspwmrc
+
+```
+pidof bspswallow || bspswallow
+```
+
+Now just restart bspwm and you're good to go.