From b1dc5818c96eb07b5ffed09abcfdc51810ba0151 Mon Sep 17 00:00:00 2001
From: JopStro <33031853+JopStro@users.noreply.github.com>
Date: Tue, 9 Jun 2020 14:04:02 +0100
Subject: Update README.md

---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

(limited to 'README.md')

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.
-- 
cgit v1.2.3