Skip to content

Commit

Permalink
new version update
Browse files Browse the repository at this point in the history
  • Loading branch information
Anze committed Sep 8, 2023
1 parent c581241 commit d5a66d0
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 12 deletions.
10 changes: 10 additions & 0 deletions changelog.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
v0.12
- fixed issue with hiding persistent panel when focused
- improved work with multi-monitor environment
- added integration with CustomShortcuts to customize shortcuts
- added possibility to pause/resume app
- added possibility to toggle Shortcuts panel from menu
- added possibility to toggle Persistent panel from menu
- updated Settings window to modern look
- updated app icon, thanks to wanwindwalker

v0.11
- fixed bug which might lead to crash in macOS 14
- changed accessing Settings window shortcut key, from pressing ⌘(cmd) 3 times to ⌃(ctrl) 3 times
Expand Down
Binary file modified img/keyclu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 18 additions & 12 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,34 +20,40 @@ Simple and handy overview of all shortcuts for any application. Easy to use: jus

### Install

#### Using Homebrew

#### Homebrew
```
brew install --cask keyclu
```

#### Manual download
Latest version can be found here:
* [download .dmg](https://github.com/Anze/KeyCluCask/releases/latest)
* [download .zip](https://github.com/Anze/KeyCluCask/releases/latest)
#### Manual
* [latest version](https://github.com/Anze/KeyCluCask/releases/latest)

### Access
KeyClu ask for permissions:
* Accessibility - require to operate
* Notification Center - optional, gentle update notification
### Permissions
* Required access to `Accessibility API` to operate.
* Preferred to have access to `Notification Center` to provide gentle update notification.

### Usage
* Press `` key twice and hold (default) to present shortcuts of current app
* Press `` key and hold (alternative) to present shortcuts of current app
* Press `` key 3 times to toggle persistent panel
* Trigger show shortcuts panel by passing `--show-shortcuts` param
* Toggle persistent panel by passing `--toggle-persistent` param

### Integrations
* [CustomShortcuts](https://www.houdah.com/customShortcuts/) to customize shortcuts.
* Other tools like [skhd](https://github.com/koekeishiya/skhd) to change KeyClu activation hotkey:
* Trigger show shortcuts panel by passing `--show-shortcuts` param
* Toggle persistent panel by passing `--toggle-persistent` param

If icon of the App is hidden in menu bar, you can call Settings window by quickly pressing ``(ctrl) key 3 times.

### License
KeyClu is released under the BSD-3-Clause-Clear license. See [LICENSE](LICENSE) for details.

### Privacy Policy
KeyClu collects no personal information nor does use any services for analytics, advertising etc.

### Contributors
* [wanwindwalker](https://github.com/wanwindwalker) updated app icon.

### Thanks
Thanks to all the people who made suggestions and reported bugs. Thank you guys so much!

Expand Down

0 comments on commit d5a66d0

Please sign in to comment.