summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 20 insertions, 17 deletions
diff --git a/README.md b/README.md
index c507402..909ac19 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# i3bar-river
+# i3bar-mango
-This is a port of `i3bar` for wlroots-based window managers. Tags/workspaces are implemented for [river](https://codeberg.org/river/river), [hyprland](https://github.com/hyprwm/Hyprland) and [niri](https://github.com/YaLTeR/niri).
+This is a port of `i3bar` for [mangowm](https://github.com/mangowm/mango), with support for other wlroots-based window managers ([river](https://codeberg.org/river/river), [hyprland](https://github.com/hyprwm/Hyprland) and [niri](https://github.com/YaLTeR/niri)) available as compile-time features.
## i3bar compatibility
@@ -9,36 +9,31 @@ I've tested [`i3status-rs`](https://github.com/greshake/i3status-rust), [`bumble
A list of things that are missing (for now):
- `border[_top|_right|_bottom|_left]`
- Click events lack some info (IDK if anyone actually relies on `x`, `y`, `width`, etc.)
-- Tray icons
## Features
-- `river` support (obviously)
+- `mango` support (obviously)
- `short_text` switching is "progressive" (see https://github.com/i3/i3/issues/4113)
- Support for rounded corners
-- Show/hide with `pkill -SIGUSR1 i3bar-river`
+- Show/hide with `pkill -SIGUSR1 i3bar-mango`
## Installation
-[![Packaging status](https://repology.org/badge/vertical-allrepos/i3bar-river.svg)](https://repology.org/project/i3bar-river/versions)
+[![Packaging status](https://repology.org/badge/vertical-allrepos/i3bar-mango.svg)](https://repology.org/project/i3bar-mango/versions)
### From Source
External dependencies: `libpango1.0-dev`.
```
-cargo install --locked i3bar-river
+cargo install --locked i3bar-mango
```
## Configuration
-Add this to the end of your river init script:
+Add `i3bar-mango` to your mangowm autostart.
-```
-riverctl spawn i3bar-river
-```
-
-The configuration file should be stored in `$XDG_CONFIG_HOME/i3bar-river/config.toml` or `~/.config/i3bar-river/config.toml`.
+The configuration file should be stored in `$XDG_CONFIG_HOME/i3bar-mango/config.toml` or `~/.config/i3bar-mango/config.toml`.
The default configuration (every parameter is optional):
@@ -85,6 +80,14 @@ blend = true # whether tags/blocks colors should blend with bar's background
show_mode = true
start_hidden = false # whether the bar is initially in the 'hidden' state
+# System tray (StatusNotifierItem)
+[tray]
+enabled = true # host SNI tray icons (the bar acts as the StatusNotifierWatcher)
+expanded = false # start collapsed; the ▸/▾ button toggles the tray
+show_icon = true # show the item icon
+show_name = true # show the item title
+show_description = false # append the item's tooltip description after the title
+
# WM-specific options
[wm.river]
max_tag = 9 # Show only the first nine tags
@@ -106,7 +109,7 @@ 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`.
+`i3bar-mango` 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.
@@ -121,7 +124,7 @@ Sometimes `pango` lives a gap between "powerline separators" and the blocks (see
![Native separators demo](../assets/native_demo.png?raw=true)
-`i3bar-river`
+`i3bar-mango`
```toml
font = "JetBrainsMono Nerd Font 10"
@@ -146,7 +149,7 @@ critical_fg = "#fb4934"
![Powerline separators demo](../assets/powerline_demo.png?raw=true)
-`i3bar-river`
+`i3bar-mango`
```toml
font = "JetBrainsMono Nerd Font 10"
@@ -165,7 +168,7 @@ theme = "slick"
![Rounded corners demo](../assets/rounded_corners_demo.png?raw=true)
-`i3bar-river`
+`i3bar-mango`
```toml
font = "JetBrainsMono Nerd Font 10"