From 645bb8b69615ed9c1d4d4c321e3a4d805895c164 Mon Sep 17 00:00:00 2001 From: 2 * r + 2 * t <61896496+soramanew@users.noreply.github.com> Date: Sun, 8 Jun 2025 15:05:10 +1000 Subject: readme: add usage section --- README.md | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 513782d..c7901ef 100644 --- a/README.md +++ b/README.md @@ -13,30 +13,42 @@ https://github.com/user-attachments/assets/0840f496-575c-4ca6-83a8-87bb01a85c5f ## Components -- Widgets: [`Quickshell`](https://quickshell.outfoxxed.me/) -- Window manager: [`Hyprland`](https://hyprland.org/) -- Dots: [`caelestia`](https://github.com/caelestia-dots/) +- Widgets: [`Quickshell`](https://quickshell.outfoxxed.me) +- Window manager: [`Hyprland`](https://hyprland.org) +- Dots: [`caelestia`](https://github.com/caelestia-dots) ## Installation ### Automated installation (recommended) -Install [`caelestia-scripts`](https://github.com/caelestia-dots/scripts/) and run `caelestia install shell`. +Install [`caelestia-scripts`](https://github.com/caelestia-dots/scripts) and run `caelestia install shell`. ### Manual installation -Install all [dependencies](https://github.com/caelestia-dots/scripts/blob/main/install/shell.fish#L10/), then +Install all [dependencies](https://github.com/caelestia-dots/scripts/blob/main/install/shell.fish#L10), then clone this repo into `$XDG_CONFIG_HOME/quickshell/caelestia` and run `qs -c caelestia`. +## Usage + +All keybinds are accessible via Hyprland [global shortcuts](https://wiki.hyprland.org/Configuring/Binds/#dbus-global-shortcuts). +For a preconfigured setup, install [`caelestia-hypr`](https://github.com/caelestia-dots/hypr) via `caelestia install hypr` or see +[this file](https://github.com/caelestia-dots/hypr/blob/main/hyprland/keybinds.conf#L1-L29) for an example on how to use global +shortcuts. + +There is only one IPC command as of now which can be used to get details about the currently active MPRIS player. +```sh +caelestia shell mpris getActive +``` + ## Credits Thanks to the Hyprland discord community (especially the homies in #rice-discussion) for all the help and suggestions for improving these dots! -A special thanks to [@outfoxxed](https://github.com/outfoxxed/) for making Quickshell and the effort put into fixing issues +A special thanks to [@outfoxxed](https://github.com/outfoxxed) for making Quickshell and the effort put into fixing issues and implementing various feature requests. -Another special thanks to [@end_4](https://github.com/end-4/) for his [config](https://github.com/end-4/dots-hyprland) +Another special thanks to [@end_4](https://github.com/end-4) for his [config](https://github.com/end-4/dots-hyprland) which helped me a lot with learning how to use Quickshell. ## Stonks 📈 -- cgit v1.2.3-freya