rethocker 0.1.5 → 0.2.1

package/README.md

@@ -6,6 +6,27 @@ Requires **macOS 13+** and **Accessibility permission** (prompted automatically
 
 ## Install
 
+### Homebrew (recommended)
+
+```bash
+brew tap benjamine/tap
+brew install rethocker
+rethocker install
+```
+
+`rethocker install` scaffolds `~/.config/rethocker/default.ts` and registers a LaunchAgent that starts on login and auto-reloads whenever you save the file.
+
+```bash
+rethocker log      # live key monitor — see what rethocker captures
+rethocker status   # check if the background agent is running
+rethocker restart  # restart the background agent
+rethocker uninstall # stop and remove the LaunchAgent (run before brew uninstall)
+```
+
+### Programmatic use (TypeScript / Bun)
+
+If you want to use rethocker as a library in your own TypeScript project:
+
 ```bash
 bun add rethocker
 ```
@@ -232,6 +253,8 @@ actions.window.thirdCenter()
 actions.window.thirdRight()
 actions.window.quarterTopLeft()
 actions.window.maximize()
+
+// NOTE: you can use this to compose any custom layouts
 actions.window.halfLeft("Figma")      // move specific app
 
 // App management
@@ -251,8 +274,6 @@ actions.media.volumeDown(10)
 // System
 actions.system.sleep()
 actions.system.lockScreen()
-actions.system.missionControl()
-actions.system.emptyTrash()
 
 // Run a Shortcut from the macOS Shortcuts app
 actions.shortcut("My Shortcut Name")
@@ -302,13 +323,13 @@ rk.remove("caps-remap")
 
 ## Discover key codes
 
-Run the included debug script to see what keys produce:
+Run the live key monitor to see every keypress in rethocker rule syntax:
 
 ```bash
-bun node_modules/rethocker/src/scripts/debug-keys.ts
+rethocker log
 ```
 
-Output shows keyCode, modifiers, and active app for every keypress — useful for finding the right key name or checking that app filters work correctly.
+Keys pressed in quick succession appear on the same line separated by spaces, exactly as you'd write them in a rule. Useful for finding the right key name or verifying that app filters work correctly.
 
 ## Events and lifecycle
 
@@ -344,48 +365,3 @@ await rk.stop()
 // (by default rethocker keeps the event loop alive)
 rk.unref()
 ```
-
-## API reference
-
-### `rethocker(rules?, options?)` → `RethockerHandle`
-
-| Option | Type | Description |
-|---|---|---|
-| `binaryPath` | `string?` | Override the native binary path |
-
-### `RethockerHandle`
-
-| Method | Returns | Description |
-|---|---|---|
-| `add(rule \| rule[])` | `void` | Add one or more rules |
-| `remove(id)` | `void` | Remove a rule permanently |
-| `enable(id?)` | `void` | Enable a rule by ID, or all rules if no ID |
-| `disable(id?)` | `void` | Disable a rule by ID, or all rules if no ID |
-| `on(event, listener)` | `() => void` | Subscribe to an event; returns an unsubscribe function |
-| `execute(command)` | `Promise<void>` | Run a shell command immediately (accepts `string \| string[]`) |
-| `start()` | `Promise<void>` | Await daemon readiness (optional) |
-| `stop()` | `Promise<void>` | Stop the daemon |
-| `unref()` | `void` | Allow the process to exit while the daemon runs |
-| `ready` | `boolean` | Whether the daemon is ready |
-
-### Events
-
-| Event | Arguments | Description |
-|---|---|---|
-| `"ready"` | — | Daemon ready |
-| `"key"` | `KeyEvent` | Every key event (stream auto-activates on subscribe) |
-| `"accessibilityDenied"` | — | Accessibility permission not granted |
-| `"error"` | `code, message` | Native daemon error |
-| `"exit"` | `code` | Native process exited unexpectedly |
-
-### `KeyEvent`
-
-| Field | Type | Description |
-|---|---|---|
-| `type` | `"keydown" \| "keyup" \| "flags"` | Event type |
-| `keyCode` | `number` | macOS virtual key code |
-| `modifiers` | `Modifier[]` | Active modifiers |
-| `app` | `string?` | Frontmost app display name |
-| `appBundleID` | `string?` | Frontmost app bundle ID |
-| `suppressed` | `boolean` | Whether the key was consumed |
-| `ruleID` | `string?` | ID of the matched rule |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rethocker",
-  "version": "0.1.5",
+  "version": "0.2.1",
   "description": "Intercept and remap global keys on macOS — with per-app and key-sequence support",
   "type": "module",
   "main": "src/index.ts",

package/src/cli.ts

@@ -196,10 +196,10 @@ Commands:
               so you can copy-paste them directly into your config
   help        Print this help message
 
-Examples:
+Install via Homebrew:
+  brew tap benjamine/tap
+  brew install rethocker
   rethocker install
-  rethocker log
-  rethocker status
 
 Docs: ${GITHUB}
 `.trim();