From ac3ebf4d46eec0fbb86239589b1b8f374cadff8f Mon Sep 17 00:00:00 2001
From: fdev31 <fdev31@gmail.com>
Date: Fri, 28 Apr 2023 22:58:02 +0200
Subject: [PATCH] doc update

---
 README.md                    | 11 ++++++++++-
 pyprland/plugins/monitors.py |  2 +-
 2 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index ca9ff81..c50cbc9 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@ A single config file `~/.config/hypr/pyprland.json` is used, using the following
 
 - `scratchpad` implements dropdowns & togglable poppups
 - `monitors` allows relative placement of monitors depending on the model
-- `workspaces_follow_focus` provides commands and handlers allowing a more flexible workspaces usage on multi-monitor setups
+- `workspaces_follow_focus` provides commands and handlers allowing a more flexible workspaces usage on multi-monitor setups. If you think the multi-screen behavior of hyprland is not usable or broken/unexpected, this is probably for you.
 
 ## Installation
 
@@ -76,6 +76,7 @@ Create a configuration file in `~/.config/hypr/pyprland.json` enabling a list of
         "topOf": "eDP-1"
       }
     }
+    "unknown": "wlrlui"
   }
 }
 ```
@@ -90,6 +91,8 @@ Allows relative placement of monitors depending on the model ("description" retu
 
 ### Configuration
 
+#### `placement`
+
 Supported placements are:
 
 - leftOf
@@ -97,6 +100,12 @@ Supported placements are:
 - rightOf
 - bottomOf
 
+#### `unknown`
+
+If set, runs the associated command for screens which aren't matching any of the provided placements (pattern isn't found in monitor description).
+
+**Note** this is supposed to be a short lived command which will block the rest of the process until closed. In other words no plugin will be processed while this command remains open.
+
 ## `workspaces_follow_focus` plugin
 
 Make non-visible workspaces follow the focused monitor.
diff --git a/pyprland/plugins/monitors.py b/pyprland/plugins/monitors.py
index 964b292..74e2dfa 100644
--- a/pyprland/plugins/monitors.py
+++ b/pyprland/plugins/monitors.py
@@ -71,6 +71,6 @@ class Extension(Plugin):
 
                         configure_monitors(monitors, screenid, x, y)
                         return
-        default_command = self.config.get("noplacement")
+        default_command = self.config.get("unknown")
         if default_command:
             subprocess.call(default_command, shell=True)