Some updates to the README

This commit is contained in:
Andrew Kitchen 2022-02-18 18:20:01 -08:00
parent 2d7b4605eb
commit 274e1dff5c
5 changed files with 28 additions and 24 deletions

View file

@ -1,26 +1,30 @@
# Keycastr
# KeyCastr
KeyCastr, an open-source keystroke visualizer.
KeyCastr, an open source keystroke visualizer.
![preview](assets/preview.png)
![header image](assets/KeyCastr_header.png)
KeyCastr enables you to share your keystrokes when creating screencasts, presenting, or collaborating with others. You can choose to display all keystrokes or command keys only, and there is also an option to include mouse clicks.
It is also possible to develop your own visualizer on top of KeyCastr -- pull requests are welcome!
![display preferences](assets/preferences.png)
## Download
## Installation
- [Download latest release](https://github.com/keycastr/keycastr/releases)
Download the latest release from [GitHub](https://github.com/keycastr/keycastr/releases)
## Installation via [homebrew](http://brew.sh/) [cask](https://github.com/caskroom/homebrew-cask)
Or, install using [homebrew](http://brew.sh/)
```console
brew install --cask keycastr
```
## Enabling Accessibility API Access
## Granting Permissions
KeyCastr requires access to the macOS Accessibility API in order to receive your key events and broadcast the keystrokes you are interested in.
KeyCastr requires your permission to receive events from macOS in order to broadcast your keystrokes and mouse clicks.
On newer versions of macOS (10.15+) there is a new Input Monitoring menu under Security & Privacy within the System Preferences app, and KeyCastr will appear there automatically the first time you run it. Simply unlock this menu and check the box next to KeyCastr to enable it.
On newer versions of macOS (10.15+) there is an Input Monitoring menu under Security & Privacy within the System Preferences app, and KeyCastr will appear there automatically the first time you run it. Simply unlock this menu and check the box next to KeyCastr to enable it.
![input_monitoring](assets/input_monitoring.png)
@ -28,17 +32,9 @@ On older versions of macOS, or if for some reason the app doesn't appear under t
![accessibility](assets/accessibility.png)
To add KeyCastr to the list click the <kbd>&plus;</kbd> button and select KeyCastr from the file system.
To add KeyCastr to the list click the <kbd>&plus;</kbd> button and select KeyCastr from the file system, or drag it in using Finder.
If KeyCastr is already in the list, then click the <kbd>&minus;</kbd> button and add KeyCastr again to be certain that the right application is chosen.
## Displaying All Keystrokes
Make sure to check the "Display all keystrokes" checkbox if you would like to display more than just the modifier keys.
Alternatively, keep this box unchecked to only display modifier keys (e.g. ⇧ ⌃ ⌥ ⌘)
![display_all_keystrokes](assets/display_all_keystrokes.png)
If KeyCastr is already in the list you can remove it with the <kbd>&minus;</kbd> button and add it again in order to be certain that the right copy of the application is specified.
## Position on Screen
@ -46,14 +42,22 @@ The default position is on the bottom left of your display. To modify the positi
![reposition](assets/reposition.gif)
## History
## Security Concerns
- [sdeken](https://github.com/sdeken/keycastr) wrote the original version.
- [akitchen](https://github.com/akitchen/keycastr) fixes for more recent OS X releases and other maintenance.
- [elia](https://github.com/elia/keycastr) created `keycastr` organization and forked into it.
- [lqez](https://github.com/lqez/keycastr) added a new menu bar icon.
From time to time questions arise as to the trustworthiness of KeyCastr as an application which receives input events from macOS. KeyCastr is completely free and open source, and does not employ any networking mechanisms other than that included with the ubiquitous [Sparkle framework](https://sparkle-project.org/) for managing application updates. KeyCastr will never receive or display your passwords, so long as the website or application you are using treats password entry as secure, e.g. `<input type="password">` or equivalent.
Please understand that any application in the Accessibility or Input Monitoring sections of the Security & Privacy pane in macOS's Preferences.app is capable of receiving all your input events. We encourage you to inspect these lists carefully, remove applications which you don't believe need to monitor your input, and ask tough questions of the companies which produce the closed source software you use.
## History and Credits
- [sdeken](https://github.com/sdeken) wrote the original version.
- [akitchen](https://github.com/akitchen) occasional development and maintenance.
- [elia](https://github.com/elia) created `keycastr` organization and forked into it.
- [lqez](https://github.com/lqez) added a new menu bar icon.
- [QuintB](https://github.com/QuintB) designed an updated application icon to match the icon style in modern versions of macOS.
## License
[BSD 3-Clause](https://opensource.org/licenses/BSD-3-Clause)
KeyCastr has been freely available for the Mac since 2009.

BIN
assets/KeyCastr_header.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 198 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 KiB

After

Width:  |  Height:  |  Size: 140 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB