move the docs, update the formatting

godbout · Jan 23, 2025 · 5b26d03 · 5b26d03
1 parent 85b770e
commit 5b26d03
Showing 1 changed file with 10 additions and 86 deletions.
diff --git a/README.md b/README.md
@@ -7,104 +7,28 @@ https://github.com/user-attachments/assets/4642a003-46a8-4989-936f-409706be32de
 
 ---
 
-# The Site
+# THE SITE
 
-Best marketing site for any of my apps so far: [Scrolla.app](https://scrolla.app)
+best marketing site for any of my apps so far: [Scrolla.app](https://scrolla.app)
 
-# Why Scrolla
+# WHY SCROLLA
 
-I'm lazy af. Can't be bothered moving the hands away from the keyboard.
+i'm lazy af. can't be bothered moving the hands away from the keyboard.
 
-# License
+# THE LICENSE
 
-No license. Scrolla is free. It's not open-source because it's sharing private packages with [kindaVim](https://github.com/godbout/kindaVim.docs) and [Wooshy](https://github.com/godbout/Wooshy.docs). But maybe one day. But most probably never.
+no license. Scrolla is free. it's not open-source because it's sharing private packages with [kindaVim](https://github.com/godbout/kindaVim.docs) and [Wooshy](https://github.com/godbout/Wooshy.docs). but maybe one day. but most probably never. (not true tho as a system has been put in place to release Scrolla open source in case of death.)
 
-# Usage
+# THE DOCS
 
-## Auto Mode (default)
+THE DOCS are now at https://docs.scrolla.app. still looking a bit funky sorry.
 
-Navigate through the different detected Scroll Areas of the frontmost window with:
-
-| scroll area     | key | 
-| :---:           | :---:
-| next            | `tab` or `down` or `control n` or `J`
-| previous        | `shift tab` or `up` or `control p` or `K`
-| first           | `command up`
-| last            | `command down`
-| halfway up      | `control up`
-| halfway down    | `control down`
-| exit            |  `escape` or `return` or `i` or _your global hotkey_
-
-If you use [kindaVim](https://github.com/godbout/kindaVim.docs), then you'll be able to navigate with Vim moves by entering Normal Mode and:
-
-| scroll area     | kindaVim move | 
-| :---:           | :---: 
-| next            | `j` or `down` or `control j` or `control n`
-| previous        | `k` or `up` or `control p`
-| first           | `gg`
-| last            | `G`
-| halfway up      | `control b` or `control u` 
-| halfway down    | `control f` or `control d`
-
-## Manual Mode
-
-For the web and some shit apps (Electron, Java) Scrolla cannot detect the Scroll Areas automatically. For those cases you can move the cursor manually with:
-
-| focused window  | key |
-| :---:           | :---:
-| top left        | `1`
-| top middle      | `2`
-| top right       | `3`
-| middle left     | `4`
-| middle middle   | `5`
-| middle right    | `6`
-| bottom left     | `7`
-| bottom middle   | `8`
-| bottom right    | `9`
-
-The placement is not mathematically precise. Instead, Scrolla moves the cursor to a location that is more likely to be within a Scroll Area.
-
-## Scroll
-
-Scroll with:
-
-| scroll area       |  key 
-| :---:             | :---: 
-| up a bit          | `k`
-| right a bit       | `l`
-| down a bit        | `j`
-| left a bit        | `h`
-| up a lot          | `u` or `control u` or `b` or `control b` or `shift space`
-| down a lot        | `d` or `control d` or `f` or `control f` or `space`
-| to the top        | `gg`
-| to the most right | `$`
-| to the bottom     | `G`
-| to the most left  | `0`
-
-# 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.
-
-The Notifications Names are:
-* ScrollaDidEngage
-* ScrollaDidDisengage
-
-## Custom URLs
-
-You can control Scrolla programmatically by calling the following Custom URLs:
-* start: `scrolla://start`
-* stop: `scrolla://stop`
-* toggle: `scrolla://toggle`
-
-# Roadmap
+# THE ROADMAP
 
 * custom key mapping
 * stop stealing focus from current window
 
-# Alternatives
+# THE ALTERNATIVES
 
 * [Vimac](https://github.com/dexterleng/vimac) (open source, free)
 * [Keyboard Scroller](https://github.com/dexterleng/KeyboardScroller.docs) (closed source, free)