~grtcdr/citron

8742fd8bd91062400cd52b1e2d4a4f2fb50dcd57 — grtcdr 1 year, 1 month ago 3dae8c0
Add usage steps to README
1 files changed, 15 insertions(+), 2 deletions(-)

M README.md
M README.md => README.md +15 -2
@@ 40,9 40,22 @@ cd citron
cargo build --release
```

# Getting started
# Usage

See the [main wiki page](https://man.sr.ht/~grtcdr/citron/).
citron is designed to integrate directly into your window manager or
desktop environment through a set of user-defined keybindings - here's
an example configuration for [sway](https://swaywm.org/):

```
bindsym {
   $mod+Alt+b exec citron battery   # Show a battery notification
   $mod+Alt+d exec citron date      # Show a date notification
   $mod+Alt+l exec citron backlight # Show a backlight notification
   $mod+Alt+m exec citron memory    # Show a memory notification
   $mod+Alt+n exec citron network   # Show a network notification
   $mod+Alt+u exec citron uptime    # Show an uptime notification
}
```

# Configuration