Update README.md

README.md

@@ -1,18 +1,41 @@
 # SWAY Workspace manipulation helper
-#### motivation
-i was unhappy how sway handles user interaction with workspaces especially when you have additional monitors connected.
-This program tries very hard to keep all workspace operations on the output where the the currently focused container resides.
-Also it seconds as a replacement for a bash script to integrate workspaces in rofi.
+less confusing rename / switch / reorder workspaces.
+This program tries very hard to keep all workspace operations on the focused monitor.
+Also it seconds as a binary for selecting, or renaming workspaces in rofi.
 
 
 ## Features
-- [next/prev command to select adjacent Workspaces ( stays on the active monitor) ](#select-workspace)
+- [next/prev command to select adjacent Workspaces on the same monitor, (unlike sway's 'workspace next' command) ](#select-workspace)
 - [swap current workspace with previous / next workspace on the currently active monitor](#select-workspace)
 - [reorder workspaces by increasing/decreasing workspace Number](#index-workspace)
 - [rename a workspace without changing the workspace Number](#rename-workspace)
 - rename/select workspace via rofi
 - move container to workspace on same output
 - [select workspace by number on same output](#select-workspace-while-multiple-monitors-are-connected)
+##### How to read the following Block Diagrams
+```
+full command including arguments
+```
+```mermaid
+block-beta
+  columns 2
+    block:a1["Monitor | initial state"]:1
+      columns 3
+      A1["Workspace"]
+      B1["Active Workspace"]
+      space:6
+    end
+  space:3
+    block:b1["Monitor | state after invocating command"]:1
+      columns 3
+      C1["Active Workspace"}
+      D1["Workspace"]
+      space:6
+    end
+  a1 -- "command arguments" --> b1
+  style B1 fill:#ccc,stroke:#333,stroke-width:4px
+  style C1 fill:#ccc,stroke:#333,stroke-width:4px
+```
 
 ##### Select Workspace
 ```
@@ -38,8 +61,8 @@ block-beta
     H["6 work"]
     I["8 messages"]
   end
-  a --> b
-  b --> c
+  a -- "next" --> b
+  b -- "next" --> c
   style B fill:#ccc,stroke:#333,stroke-width:4px
   style F fill:#ccc,stroke:#333,stroke-width:4px
   style G fill:#ccc,stroke:#333,stroke-width:4px
@@ -61,7 +84,7 @@ block-beta
     E["6 work"]
     F["8 messages"]
   end
-  a --> b
+  a -- "prev" --> b
   style B fill:#ccc,stroke:#333,stroke-width:4px
   style D fill:#ccc,stroke:#333,stroke-width:4px
 
@@ -90,8 +113,8 @@ block-beta
     H["6 messages"]
     I["8 music"]
   end
-  a --> b
-  b --> c
+  a -- "swap_with_next"--> b
+  b -- "swap_with_next"--> c
   style B fill:#ccc,stroke:#333,stroke-width:4px
   style F fill:#ccc,stroke:#333,stroke-width:4px
   style G fill:#ccc,stroke:#333,stroke-width:4px
@@ -113,7 +136,7 @@ block-beta
     E["6 music"]
     F["8 messages"]
   end
-  a --> b
+  a -- "swap_with_prev" --> b
   style B fill:#ccc,stroke:#333,stroke-width:4px
   style D fill:#ccc,stroke:#333,stroke-width:4px
 ```
@@ -141,8 +164,8 @@ block-beta
     H["7 messages"]
     I["8 work"]
   end
-  a --> b
-  b --> c
+  a -- "increase"--> b
+  b -- "increase"--> c
   style B fill:#ccc,stroke:#333,stroke-width:4px
   style E fill:#ccc,stroke:#333,stroke-width:4px
   style I fill:#ccc,stroke:#333,stroke-width:4px
@@ -164,7 +187,7 @@ block-beta
     E["6 work"]
     F["8 messages"]
   end
-  a --> b
+  a -- "decrease"--> b
   style B fill:#ccc,stroke:#333,stroke-width:4px
   style E fill:#ccc,stroke:#333,stroke-width:4px
 
@@ -187,7 +210,7 @@ block-beta
     E["6 work"]
     F["8 messages"]
   end
-  a --> b
+  a -- "rename_to movies"--> b
   style A fill:#ccc,stroke:#333,stroke-width:4px
   style D fill:#ccc,stroke:#333,stroke-width:4px
 ```
@@ -222,7 +245,7 @@ block-beta
       B2["5"]
       space:6    
     end
-  a1 --> b1
+  a1 -- "number 5" --> b1
   style B1 fill:#ccc,stroke:#333,stroke-width:4px
   style C1 fill:#ccc,stroke:#333,stroke-width:4px
 ```