diff --git a/README.md b/README.md index cfcb60b..8a02150 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,31 @@ -
- - -
A next-generation hotkey daemon for Wayland/X11 written in Rust.
- - - +# SOHKD -## SWHKD +**S**imple **O**dilia **H**ot**K**ey **D**aemon -**S**imple **W**ayland **H**ot**K**ey **D**aemon +*A next-generation hotkey daemon for Wayland/X11 written in Rust.* -swhkd is a display protocol-independent hotkey daemon made in Rust. swhkd uses an easy-to-use configuration system inspired by sxhkd so you can easily add or remove hotkeys. +sohkd is a display protocol-independent hotkey daemon made in Rust (based off the original, [swhkd](https://waycrate.github.io/swhkd/)). sohkd uses an easy-to-use configuration system inspired by swhkd so you can easily add or remove hotkeys, and it integrates with the [Odilia screen reader](https://odilia.app) to provide modal access to key bindings. -It also attempts to be a drop-in replacement for sxhkd, meaning, your sxhkd config file is also compatible with swhkd. - -Because swhkd can be used anywhere, the same swhkd config can be used across Xorg or Wayland desktops, and you can even use swhkd in a tty. +Because sohkd can be used anywhere, the same sohkd config can be used across Xorg or Wayland desktops, and you can even use swhkd in a tty. **Note: The project is a WIP.** **BUT!! It does work right now however it's not a drop-in replacement yet. [Example config file](./docs/swhkdrc).** ## Installation -See [INSTALL.md](./docs/INSTALL.md) for installing swhkd. +See [INSTALL.md](./docs/INSTALL.md) for installing sohkd. ## Running: ```bash -swhks & -pkexec swhkd +sohks & +pkexec sohkd ``` To refresh the config at runtime, make a script like so: ```bash #!/bin/sh -sudo killall swhkd -pkexec swhkd +sudo killall sohkd +pkexec sohkd ``` Mark it as executable using `chmod +x