rounded corners

1 files changed, 93 insertions, 0 deletions

diff --git a/README.md b/README.md
index 4c18872..e43647c 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,7 @@ A list of things that are missing (for now):
 
 - `river` support (obviously)
 - `short_text` switching is "progressive" (see https://github.com/i3/i3/issues/4113)
+- Support for rounded corners
 
 ## Installation
 
@@ -54,5 +55,97 @@ tag_urgent_fg = "#282828"
 tag_urgent_bg = "#cc241d"
 font = "JetBrainsMono Nerd Font 10"
 height = 20
+separator_width = 0
+tags_r = 6
+blocks_r = 6
+blocks_overlap = 0
 command = "i3status-rs"
 ```
+
+## How progressive short mode and rounded corners work
+
+Some status bar generators (such as `i3status-rs`) use more than one "json block" per logical block
+to implement, for example, buttons.
+
+_Short text management and corner rounding are performed on per-logical-block basis._
+
+`i3bar-river` defines a logical block as a continuous series of "json blocks" with the same `name`.
+Also, only the last "json block" is allowed to have a non zero (or absent) `separator_block_width`,
+all the other "json blocks" should explicitly set it to zero. If you think this definition is not
+the best one, feel free to open a new github issue.
+
+## `blocks_overlap` option
+
+Sometimes `pango` lives a gap between "powerline separators" and the blocks (see https://github.com/greshake/i3status-rust/issues/246#issuecomment-1086753440). In this case, you can set `blocks_overlap` option to number of pixels you want your blocks to overlap. Usually, `1` is a good choice.
+
+## Showcase (with i3status-rs)
+
+### Native separators
+
+![Native separators demo](../assets/native_demo.png?raw=true)
+
+`i3bar-river`
+
+```toml
+font = "JetBrainsMono Nerd Font 10"
+height = 20
+command = "i3status-rs"
+```
+
+`i3status-rs`
+
+```toml
+[theme]
+name = "native"
+[theme.overrides]
+idle_fg = "#ebdbb2"
+info_fg = "#458588"
+good_fg = "#8ec07c"
+warning_fg = "#fabd2f"
+critical_fg = "#fb4934"
+```
+
+### Powerline separators
+
+![Powerline separators demo](../assets/powerline_demo.png?raw=true)
+
+`i3bar-river`
+
+```toml
+font = "JetBrainsMono Nerd Font 10"
+height = 20
+command = "i3status-rs"
+```
+
+`i3status-rs`
+
+```toml
+[theme]
+name = "slick"
+```
+
+### Rounded corners
+
+![Rounded corners demo](../assets/rounded_corners_demo.png?raw=true)
+
+`i3bar-river`
+
+```toml
+font = "JetBrainsMono Nerd Font 10"
+height = 20
+separator_width = 0
+tags_r = 6
+blocks_r = 6
+command = "i3status-rs"
+```
+
+`i3status-rs`
+
+```toml
+[theme]
+name = "slick"
+[theme.overrides]
+separator = "native"
+alternating_tint_bg = "none"
+alternating_tint_fg = "none"
+```