From 79e140857e61a675ed14106fde99f3899247d1e3 Mon Sep 17 00:00:00 2001
From: Arne Keller <arne.keller@posteo.de>
Date: Sun, 16 May 2021 14:55:30 +0200
Subject: [PATCH] Add readme

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..620307f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# kwin-toggle-window
+
+Simple script to toggle the visibility of a window by (un-)minimizing it.  
+The relevant window is selected by searching for a specific prefix (default: Alacritty).
+
+## Configuration
+
+The window name can be changed like this:
+```
+kwriteconfig5 --file ~/.config/kwinrc --group Script-togglewindow --key WindowName <window title>
+```
+Restart KWin after changing the configuration.