Skip to content

Commit 286c7b1

Browse files
authored
chore: cleanup readme [skip ci] (#7)
1 parent e86710e commit 286c7b1

1 file changed

Lines changed: 32 additions & 46 deletions

File tree

README.md

Lines changed: 32 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616

1717
</div>
1818

19+
> [!NOTE]
20+
> This is a personal project maintained on a best-effort basis. PRs are more likely to be reviewed than feature requests or issues, unless I am facing the same problem.
21+
1922
## ✨ Features
2023

2124
- 🎯 **Hint Mode** - Click any UI element using keyboard shortcuts
@@ -55,13 +58,21 @@ System Settings → Privacy & Security → Accessibility
5558

5659
## 🎮 Usage
5760

58-
### Hint Mode
61+
### Hint Mode (Direct Click)
5962

6063
1. Press `Cmd+Shift+Space` (default)
6164
2. Clickable elements show hint labels
6265
3. Type the label to click (e.g., "aa", "ab")
6366
4. Press `Esc` to exit
6467

68+
### Hint Mode (Action)
69+
70+
1. Press `Cmd+Shift+A` (default)
71+
2. Clickable elements show hint labels
72+
3. Type the label to click (e.g., "aa", "ab")
73+
4. Choose the action to perform (e.g., "left click", "right click", "double click", "middle click")
74+
5. Press `Esc` to exit
75+
6576
### Scroll Mode
6677

6778
1. Press `Cmd+Shift+J` (default)
@@ -136,10 +147,6 @@ For app-specific settings, find the bundle ID using:
136147
osascript -e 'id of app "App Name"'
137148
```
138149

139-
## 🤝 Contributing
140-
141-
See `configs/default-config.toml` for all available options.
142-
143150
### Per-App Role Configuration
144151

145152
GoVim supports global and per-app accessibility role configurations:
@@ -154,13 +161,12 @@ To find an app's bundle ID:
154161
osascript -e 'id of app "AppName"'
155162
```
156163

157-
Example per-app configuration:
164+
For example, in `Mail.app`, lots of element are `AXStaticText` and they should be clickable. In this case, we don't want to add to the global one, as it will causes lots of unclickable hints, especially in browser space.
158165

159166
```toml
160167
[[accessibility.app_configs]]
161-
bundle_id = "com.microsoft.VSCode"
168+
bundle_id = "com.apple.mail"
162169
additional_clickable_roles = ["AXStaticText"]
163-
additional_scrollable_roles = ["AXGroup"]
164170
```
165171

166172
### Electron & Chrome Support
@@ -220,35 +226,6 @@ govim hints_action
220226
govim scroll
221227
```
222228

223-
#### Electron Apps Support
224-
225-
GoVim includes special support for Electron-based applications like VS Code and Chrome, with:
226-
227-
- Optimized element detection
228-
- Improved scrolling behavior
229-
- Better hint placement
230-
231-
## 🤝 Contributing
232-
233-
Contributions welcome! Here's how:
234-
235-
1. Fork the repository
236-
2. Create a feature branch
237-
3. Make your changes
238-
4. Run `just test` and `just lint` to verify
239-
5. Submit a pull request
240-
241-
## 📝 License
242-
243-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
244-
245-
---
246-
247-
<div align="center">
248-
Made with ❤️ by <a href="https://github.com/y3owk1n">y3owk1n</a>
249-
</div>
250-
```
251-
252229
### Examples
253230

254231
```bash
@@ -320,14 +297,6 @@ govim/
320297
└── scripts/ # Build and packaging scripts
321298
```
322299

323-
## Performance
324-
325-
- Hint generation: <100ms for typical windows
326-
- UI element detection: <50ms
327-
- Hotkey response: <10ms
328-
- Idle CPU usage: <1%
329-
- Memory usage: <50MB typical
330-
331300
## Troubleshooting
332301

333302
### Accessibility Permissions
@@ -434,7 +403,7 @@ just test-race # Race detection
434403

435404
## License
436405

437-
MIT License - see LICENSE file for details
406+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
438407

439408
## Acknowledgments
440409

@@ -444,3 +413,20 @@ Inspired by:
444413
- [Vimac](https://github.com/dexterleng/vimac)
445414
- [Shortcat](https://shortcat.app/)
446415
- [Vimium](https://github.com/philc/vimium)
416+
417+
## 🤝 Contributing
418+
419+
Contributions welcome! Here's how:
420+
421+
1. Fork the repository
422+
2. Create a feature branch
423+
3. Make your changes
424+
4. Run `just test` and `just lint` to verify
425+
5. Submit a pull request
426+
427+
---
428+
429+
<div align="center">
430+
Made with ❤️ by <a href="https://github.com/y3owk1n">y3owk1n</a>
431+
</div>
432+
```

0 commit comments

Comments
 (0)