aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkoekeishiya <aasvi93@hotmail.com>2020-01-18 14:24:06 +0100
committerkoekeishiya <aasvi93@hotmail.com>2020-01-18 14:24:06 +0100
commit33439ac680705c4f593414b61d981cf766c05b34 (patch)
treeebd839f5f36f89de9980e610f9f53d42f7f77f04
parentf68bc63fd7021898c088f170b0ac403b118597d0 (diff)
downloadskhd-33439ac680705c4f593414b61d981cf766c05b34.tar.gz
skhd-33439ac680705c4f593414b61d981cf766c05b34.zip
update readme
-rw-r--r--README.md29
1 files changed, 13 insertions, 16 deletions
diff --git a/README.md b/README.md
index 3748377..b819fc0 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,23 @@
[![Build Status](https://travis-ci.org/koekeishiya/skhd.svg?branch=master)](https://travis-ci.org/koekeishiya/skhd)
-**skhd** is a simple hotkey daemon for macOS. It is a stripped version of [**khd** (*no longer maintained*)](https://github.com/koekeishiya/khd)
-(although rewritten from scratch), that sacrifices the more advanced features in favour of increased responsiveness and performance.
-**skhd** is able to hotload its config file, meaning that hotkeys can be edited and updated live while **skhd** is running.
+**skhd** is a simple hotkey daemon for macOS that focuses on responsiveness and performance.
+Hotkeys are defined in a text file through a simple DSL. **skhd** is able to hotload its config file, meaning that hotkeys can be edited and updated live while **skhd** is running.
**skhd** uses a pid-file to make sure that only one instance is running at any moment in time. This also allows for the ability to trigger
a manual reload of the config file by invoking `skhd --reload` at any time while an instance of **skhd** is running. The pid-file is saved
as `/tmp/skhd_$USER.pid` and so the user that is running **skhd** must have write permission to said path.
-feature comparison between **skhd** and **khd**
-
-| feature | skhd | khd |
-|:--------------------------:|:----:|:---:|
-| hotload config file | [x] | [ ] |
-| hotkey passthrough | [x] | [x] |
-| modal hotkey-system | [x] | [x] |
-| application specific hotkey| [x] | [x] |
-| blacklist applications | [x] | [ ] |
-| use media-keys as hotkey | [x] | [ ] |
-| modifier only hotkey | [ ] | [x] |
-| caps-lock as hotkey | [ ] | [x] |
-| mouse-buttons as hotkey | [ ] | [x] |
+list of features
+
+| feature | skhd |
+|:--------------------------:|:----:|
+| hotload config file | [x] |
+| hotkey passthrough | [x] |
+| modal hotkey-system | [x] |
+| application specific hotkey| [x] |
+| blacklist applications | [x] |
+| use media-keys as hotkey | [x] |
+| synthesize a key-press | [x] |
### Install