From dafedc90ac7e4c47159fed4b93581a421da0ff15 Mon Sep 17 00:00:00 2001 From: G Date: Thu, 24 Nov 2022 15:56:46 +0800 Subject: [PATCH] add API --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 964a63b..6809ff1 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,15 @@ Scroll with: | to the bottom | `G` | to the most left | `0` +# APIs + +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. + +The Notifications Names are: +* ScrollaDidEngage +* ScrollaDidDisengage + # Alternatives * [Vimac](https://github.com/dexterleng/vimac) (open source, free)