From a041373a7d2aedb50b76c2d544ccbc7d2ceeeb01 Mon Sep 17 00:00:00 2001 From: Guillaume Leclerc Date: Thu, 28 Sep 2023 22:55:01 +0800 Subject: [PATCH] add Custom URLs --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 41617ec..a5e2ca4 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,8 @@ Scroll with: # APIs +## Distributed Notifications + Scrolla sends [Distributed Notifications](https://developer.apple.com/documentation/foundation/distributednotificationcenter) to macOS when it starts highlighing Areas, and when it backs off. You can listen to those Notifications with external tools like [BetterTouchTool](https://www.google.com/search?q=bettertouchtool) or [Hammerspoon](https://www.hammerspoon.org) and build your own custom workflows as a result of those Notifications. @@ -72,12 +74,15 @@ The Notifications Names are: * ScrollaDidEngage * ScrollaDidDisengage -# Alternatives +## Custom URLs -* [Vimac](https://github.com/dexterleng/vimac) (open source, free) -* [Keyboard Scroller](https://github.com/dexterleng/KeyboardScroller.docs) (closed source, free) +You can control Scrolla programmatically by calling the following Custom URLs: +* start: `scrolla://start` +* stop: `scrolla://stop` +* toggle: `scrolla://toggle` -# Roadmap +# Alternatives to Scrolla -* ~90% will do: build a proper "marketing" site -* ~40% will do: add an option to select the Scroll Area where the cursor is currently is as the first choice +* [Vimac](https://github.com/dexterleng/vimac) (open source, free) +* [Keyboard Scroller](https://github.com/dexterleng/KeyboardScroller.docs) (closed source, free) +* [Homerow](https://www.homerow.app) (closed source, one time purchase)