docs(readme): update docs with info about BonsaiBar.sync_with

README.md

@@ -278,6 +278,7 @@ screens = [
     Screen(top=bar.Bar([
         BonsaiBar(**{
             # "length": 500,
+            # "sync_with": "bonsai_on_same_screen",
             # "tab.width": 50,
             # ...
         }),
@@ -387,6 +388,7 @@ Click on the image to open a web view with the full guide.
 | Option Name | Default Value | Description |
 | ---         | ---           | ---         |
 |`length` | 500 | The standard `length` property of qtile<br>widgets.<br><br>As usual, it can be a fixed integer, or<br>one of the 'special' bar constants:<br>`bar.CALCULATED` or `bar.STRETCH`. |
+|`sync_with` | bonsai_on_same_screen | The Bonsai layout whose state should be<br>rendered on this widget.<br><br>Can be one of the following:<br>&nbsp;&nbsp;&nbsp;&nbsp;- "bonsai_with_focus":<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Bonsai layout of the window<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;that is currently focused. This<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;is relevant in a multi-screen<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;setup - the widget will keep<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;updating based on which screen's<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Bonsai layout has focus.<br>&nbsp;&nbsp;&nbsp;&nbsp;- "bonsai_on_same_screen":<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The widget will stick to<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;displaying the state of the<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Bonsai layout that is on the<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;same screen as the widget's bar. |
 |`bg_color` | None | Background color of the bar.<br>If None, the qtile-bar's' background<br>color is used. |
 |`font_family` | Mono | Font family to use for tab titles |
 |`font_size` | 15 | Size of the font to use for tab titles |

templates/README.template.md

@@ -278,6 +278,7 @@ screens = [
     Screen(top=bar.Bar([
         BonsaiBar(**{
             # "length": 500,
+            # "sync_with": "bonsai_on_same_screen",
             # "tab.width": 50,
             # ...
         }),