Skip to content

Commit

Permalink
Merge pull request #58 from Anze/v0.22
Browse files Browse the repository at this point in the history
V0.22
  • Loading branch information
Anze committed Feb 28, 2024
2 parents ffbd56b + bf72989 commit 33e8b5d
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 15 deletions.
10 changes: 10 additions & 0 deletions changelog.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
v0.22
- fixed bug with Shortcuts Panel being showed briefly if called from status menu bar or via cli
- fixed issue of incorrect targeting KeyClu as active app
- fixed issue with forced request of Notification Permission
- improved app stability and performance
- added option to show/hide My Shortcuts (Settings -> Integrations)
- added option to show/hide skhd shortcuts (Settings -> Integrations)
- added possibility to export App's menu item shortcuts to Markdown file via button M on the bottom right of Command bar
- removed feature to access Settings via tapping 3x control key when App icon is hidden

v0.21
- fixed filtering field issues (might be not all)
- fixed app stability and performance issues
Expand Down
40 changes: 25 additions & 15 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,40 +38,50 @@ Download the [latest version](https://github.com/Anze/KeyCluCask/releases/latest
* Press `` key and hold (alternative) to present shortcuts of current app

## Features
* Adjustable view
* Support `system`, `light` and `dark` theme
* Persistent panel
* Pause app
* Bookmarking shortcuts
A few of the things you can do with KeyClu:
* Adjust view to your liking
* Personalize sheme to `system`, `light` and `dark`
* Bookmark shortcuts
* Hide known shortcuts
* List own shortcuts
* List own & skhd shortcuts
* Filter and hightlight shortcuts
* Support 3rd-party integrations
* Export App's shortcuts to markdown file

## 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 shortcuts panel by passing `--show-shortcuts` param (action becomes `toggle` when App is paused)
* [CustomShortcuts](https://www.houdah.com/customShortcuts/) to customize shortcuts
* [skhd](https://github.com/koekeishiya/skhd) to list shortcuts, more details on [wiki](https://github.com/Anze/KeyCluCask/wiki/Integrations-%E2%80%90-skhd) page
* CLI tools like to manipulate KeyClu:
- Trigger shortcuts panel by passing `--show-shortcuts` param (action becomes `toggle` when KeyClu is paused)
- Toggle persistent panel by passing `--toggle-persistent` param

## FAQ
### How to open Settings if icon is hidden?
To open Settings window simply launch app again.
To open Settings simply launch app again.

### App just crashed!
In case of a crash, please open the issue and provide details, relevant logs, and a brief description of your activities that might leading up to the crash. Check the page [FAQ - KeyClu just crashed](https://github.com/Anze/KeyCluCask/wiki/FAQ#keyclu-just-crashed) for guidance on collecting the necessary information for the issue. Your cooperation will help to resolve issue more effectively.

## Roadmap
Take a look at [KeyClu's Project board](https://github.com/users/Anze/projects/1) to get an idea of what's brewing!

Feature requests are always welcome.

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

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

This software uses the following open source packages:
* [Sparkle](https://github.com/sparkle-project/Sparkle)
* [SQLite.swift](https://github.com/stephencelis/SQLite.swift)
* [SQLiteMigrationManager.swift](https://github.com/garriguv/SQLiteMigrationManager.swift)

## Thanks
* [@wanwindwalker](https://github.com/wanwindwalker) (legacy app icon)
* To all the people who made suggestions and reported bugs
* Special thanks to everyone who contributed to getting the KeyClu to the current state
* [@wanwindwalker](https://github.com/wanwindwalker) for legacy app icon

## Support
If you ❤️ the KeyClu and found it useful for your tasks, be sure to ⭐ it and maybe support me with caffeine.


You ❤️ to use KeyClu? Be sure to ⭐ it and maybe support me with caffeine.

0 comments on commit 33e8b5d

Please sign in to comment.