Skip to content

Commit fcd18b3

Browse files
jsonifyclaudegemini-code-assist[bot]
authored
Claude/fix release workflow 011 cv1 xd mgx eo72 hb vkm r51c (#21)
* ci: add Release Please configuration and documentation Add Release Please configuration files and documentation for automated version management and releases based on conventional commits. Changes: - Add Release Please manifest (.release-please-manifest.json) - Add Release Please config (release-please-config.json) - Add CHANGELOG.md for automated changelog tracking - Create comprehensive release process documentation - Update README with Release Please workflow instructions Note: Workflow files will be added in next commit (requires workflow permissions) * fix: updated the README and the ci/cd workflow * Update docs/RELEASE_PROCESS.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update README.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --------- Co-authored-by: Claude <[email protected]> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent af07b70 commit fcd18b3

File tree

5 files changed

+479
-36
lines changed

5 files changed

+479
-36
lines changed

.release-please-manifest.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
".": "1.5.5"
3+
}

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Changelog
2+
3+
All notable changes to ClickIt will be documented in this file.
4+
5+
This changelog is automatically generated by [Release Please](https://github.com/googleapis/release-please) based on [Conventional Commits](https://www.conventionalcommits.org/).
6+
7+
## [1.5.5](https://github.com/jsonify/ClickIt/releases/tag/v1.5.5) (Current Version)
8+
9+
Initial changelog. Previous release history can be found in GitHub releases.

README.md

Lines changed: 245 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,170 @@
44
[![Release](https://github.com/jsonify/ClickIt/actions/workflows/release.yml/badge.svg)](https://github.com/jsonify/ClickIt/actions/workflows/release.yml)
55
[![Latest Release](https://img.shields.io/github/v/release/jsonify/ClickIt)](https://github.com/jsonify/ClickIt/releases/latest)
66

7-
A lightweight, native macOS Auto-Clicker application with precision timing and advanced targeting capabilities. Designed for gamers, automation enthusiasts, and productivity users who need reliable, accurate clicking automation.
7+
**Professional macOS Auto-Clicker with Enterprise-Grade Precision**
8+
9+
A native macOS automation tool built with SwiftUI that delivers sub-10ms timing accuracy and advanced window targeting. Perfect for gamers, QA testers, automation professionals, and power users who demand reliable, feature-rich clicking automation.
10+
11+
## 🌟 Key Highlights
12+
13+
**Unlike other auto-clickers, ClickIt offers:**
14+
15+
1. **True Native Performance** - Built specifically for macOS with SwiftUI, not a cross-platform port
16+
2. **Advanced Window Targeting** - Click on specific apps even when they're minimized or in background
17+
3. **Sub-10ms Precision** - Professional-grade timing accuracy that competitors can't match
18+
4. **Universal Binary** - Fully optimized for both Intel and Apple Silicon processors
19+
5. **Enterprise Features** - Timer automation, preset management, and performance analytics
20+
6. **Zero Telemetry** - Your automation stays completely private and offline
21+
22+
## Why Choose ClickIt?
23+
24+
-**Lightning Fast** - Sub-10ms click timing accuracy with precision interval control
25+
- 🎯 **Smart Targeting** - Advanced window detection that works even when apps are minimized
26+
- 🌐 **Universal Binary** - Optimized for both Intel x64 and Apple Silicon processors
27+
- 🎮 **Always Active** - Background operation without requiring app focus or interruption
28+
- ⌨️ **Global Control** - System-wide hotkey support (ESC key) for instant start/stop
29+
- 💾 **Preset System** - Save and instantly load custom clicking configurations
30+
- 👁️ **Visual Feedback** - Clear overlay indicators show exactly where clicks will occur
31+
- 🔒 **Permission Aware** - Streamlined permission setup with real-time monitoring
32+
- 📊 **Performance Stats** - Built-in analytics and monitoring dashboard
33+
34+
## Core Features
35+
36+
### 🎯 Advanced Click Automation
37+
- **Sub-10ms Precision** - Industry-leading timing accuracy for demanding automation tasks
38+
- **Window-Specific Targeting** - Click on specific applications, even when minimized or in background
39+
- **Multiple Click Modes** - Single clicks, double clicks, and hold/release patterns
40+
- **Coordinate Lock** - Pin clicks to exact screen coordinates or dynamic window positions
41+
- **Human-like Variation** - Optional randomization to mimic natural clicking patterns
42+
43+
### ⚙️ Intelligent Configuration
44+
- **Preset Management** - Save unlimited custom configurations and switch instantly
45+
- **Timer Automation** - Schedule automatic start/stop times for unattended operation
46+
- **Interval Control** - Millisecond-level precision with CPS (Clicks Per Second) display
47+
- **Hotkey System** - Global ESC key control that works from any application
48+
- **Auto-Save States** - Automatically preserves your settings between sessions
49+
50+
### 📊 Professional Tools
51+
- **Real-Time Performance Dashboard** - Monitor click rate, accuracy, and system performance
52+
- **Statistics Tracking** - View elapsed time, total clicks, and success rates
53+
- **Permission Monitoring** - Live status display for Accessibility and Screen Recording permissions
54+
- **Visual Feedback System** - Customizable overlay indicators show target locations
55+
- **Smart Status Bar** - Always-visible controls with compact, unobtrusive design
56+
57+
### 🔒 Security & Reliability
58+
- **Permission-First Design** - Streamlined permission request flow with detailed instructions
59+
- **Automatic Permission Detection** - Real-time monitoring of required system permissions
60+
- **Safe Operation Mode** - Prevents accidental system-wide clicks during setup
61+
- **Crash Recovery** - Robust error handling ensures stable operation
62+
- **Privacy Focused** - No data collection, no analytics, completely offline operation
63+
64+
## Who Uses ClickIt?
65+
66+
### 🎮 Gamers
67+
- **Idle/Clicker Games** - Automate repetitive clicking in incremental games
68+
- **MMO Grinding** - Streamline repetitive tasks in online games
69+
- **Farming Simulators** - Automate resource collection and harvesting
70+
- **Achievement Hunting** - Complete click-intensive achievements efficiently
71+
72+
### 🧪 QA & Testing Professionals
73+
- **UI/UX Testing** - Simulate user interactions for interface testing
74+
- **Load Testing** - Generate consistent user input patterns
75+
- **Regression Testing** - Automate repetitive test scenarios
76+
- **Browser Testing** - Click through web application workflows
77+
78+
### 💼 Business & Productivity
79+
- **Data Entry** - Automate repetitive form filling and data input
80+
- **Batch Processing** - Handle large volumes of similar tasks
81+
- **Presentation Auto-Advance** - Automatic slideshow progression
82+
- **Monitoring Systems** - Keep applications active and responsive
83+
84+
### ♿ Accessibility & Ergonomics
85+
- **Mobility Assistance** - Reduce physical strain for users with limited mobility
86+
- **Repetitive Strain Prevention** - Minimize manual clicking to prevent RSI
87+
- **Adaptive Computing** - Enable custom interaction patterns for accessibility needs
88+
- **Fatigue Reduction** - Automate long-duration clicking tasks
89+
90+
## System Requirements
91+
92+
### Minimum Requirements
93+
- **Operating System**: macOS 15.0 (Sequoia) or later
94+
- **Processor**: Intel x64 or Apple Silicon (M1/M2/M3/M4)
95+
- **Memory**: 50 MB RAM
96+
- **Storage**: 10 MB available disk space
97+
- **Permissions**:
98+
- Accessibility (required for click simulation)
99+
- Screen Recording (required for window targeting)
100+
101+
### Recommended
102+
- **Operating System**: Latest macOS version for optimal performance
103+
- **Processor**: Apple Silicon for best energy efficiency
104+
- **Display**: Any resolution supported (tested on 1080p - 5K displays)
8105

9-
## Features
10-
11-
- **Native macOS Application**: Built with SwiftUI for optimal performance
12-
- **Universal Binary**: Supports both Intel x64 and Apple Silicon
13-
- **Advanced Window Targeting**: Works with any application, even when minimized
14-
- **Precision Timing**: Sub-10ms click timing accuracy with customizable intervals
15-
- **Visual Feedback**: Shows click points with overlay indicators
16-
- **Preset System**: Save and load custom clicking configurations
17-
- **Global Hotkeys**: System-wide controls for start/stop operations
18-
- **Variable Timing**: Human-like randomization patterns
19-
- **Background Operation**: Continues operation without requiring app focus
20-
21-
## Use Cases
22-
23-
- **Gaming**: Automated clicking for various games and applications
24-
- **Testing**: UI testing and automation workflows
25-
- **Productivity**: Repetitive task automation
26-
- **Accessibility**: Assistance for users with mobility limitations
27-
28-
## Requirements
106+
## Installation
29107

30-
- macOS 15.0 or later
31-
- Accessibility permissions (for mouse event simulation)
32-
- Screen Recording permissions (for window detection and targeting)
108+
### Quick Install (Coming Soon)
109+
Download the latest release from the [Releases page](https://github.com/jsonify/ClickIt/releases) and drag ClickIt.app to your Applications folder.
110+
111+
### First Launch Setup
112+
1. **Launch ClickIt** - Double-click the app from Applications
113+
2. **Grant Permissions** - The app will guide you through:
114+
-**Accessibility Permission** - Required for click automation
115+
-**Screen Recording Permission** - Required for window targeting
116+
3. **Start Automating** - Configure your first preset and start clicking!
117+
118+
The permission setup is streamlined with:
119+
- Clear visual indicators showing permission status
120+
- One-click access to System Settings
121+
- Real-time permission monitoring
122+
- Detailed help documentation for each permission type
123+
124+
### Troubleshooting Installation
125+
If permissions aren't working after granting them:
126+
- Click "Refresh Status" in the permission gate screen
127+
- Restart the application
128+
- Check System Settings → Privacy & Security to verify permissions are enabled
129+
130+
## 🚀 Quick Start Guide
131+
132+
### Basic Workflow
133+
1. **Select Target** - Choose "Current Mouse Position" or select a specific window
134+
2. **Set Timing** - Configure click interval (supports milliseconds or CPS)
135+
3. **Start/Stop** - Press ESC key or use the in-app controls
136+
4. **Monitor** - View real-time statistics and performance metrics
137+
138+
### Pro Tips
139+
- **Save Presets** - Create configurations for different games or applications
140+
- **Use Window Targeting** - Target specific apps to avoid accidental clicks
141+
- **Enable Visual Feedback** - See exactly where clicks will occur
142+
- **Timer Automation** - Schedule unattended clicking sessions
143+
- **Performance Dashboard** - Monitor click accuracy and system impact
144+
145+
### Common Workflows
146+
147+
**Gaming Setup:**
148+
```
149+
1. Launch your game
150+
2. Select game window as target
151+
3. Set desired CPS (clicks per second)
152+
4. Position mouse on target location
153+
5. Press ESC to start/stop
154+
```
33155

34-
## Installation
156+
**Testing Automation:**
157+
```
158+
1. Create preset for test scenario
159+
2. Configure click sequence with precise timing
160+
3. Enable visual feedback for verification
161+
4. Use timer automation for repeated tests
162+
```
35163

36-
[Installation instructions will be added once the app is ready for distribution]
164+
**Productivity Tasks:**
165+
```
166+
1. Target specific application window
167+
2. Set conservative click interval
168+
3. Use preset for quick configuration switching
169+
4. Monitor performance dashboard
170+
```
37171

38172
## Development
39173

@@ -178,29 +312,104 @@ fastlane auto_beta
178312
```
179313

180314
#### **Production Release**
315+
316+
**NEW: Automated with Release Please**
181317
```bash
182-
# 1. Promote staging to main
183-
git checkout main && git merge staging
318+
# 1. Use conventional commits
319+
git commit -m "feat: add new feature" # Minor bump
320+
git commit -m "fix: correct bug" # Patch bump
321+
git commit -m "feat!: breaking change" # Major bump
322+
323+
# 2. Merge to main (via PR)
324+
# Release Please automatically:
325+
# - Creates a release PR with version bump
326+
# - Updates CHANGELOG.md
327+
# - Creates GitHub release when PR is merged
328+
# - Triggers build workflow
329+
330+
# See docs/RELEASE_PROCESS.md for details
331+
```
184332

185-
# 2. Automated release with version bumping
333+
**Legacy: Manual Release (Deprecated)**
334+
```bash
335+
# Old process - use Release Please instead
186336
fastlane bump_and_release bump:minor # 1.0.0 → 1.1.0
187337
```
188338

189339
### 📚 **Additional Documentation**
190340
- **[CLAUDE.md](CLAUDE.md)** - Development guidance and project overview
191341
- **[BUILD_AND_DEPLOY.md](BUILD_AND_DEPLOY.md)** - Manual build and deployment instructions
192342
- **[CERTIFICATE_SETUP.md](CERTIFICATE_SETUP.md)** - Code signing certificate setup
343+
- **[docs/RELEASE_PROCESS.md](docs/RELEASE_PROCESS.md)** - Automated release process with Release Please
344+
345+
## 🤝 Contributing
346+
347+
We welcome contributions from the community! Whether you're fixing bugs, adding features, improving documentation, or helping with translations, your help is appreciated.
348+
349+
### How to Contribute
350+
351+
1. **Check Existing Issues** - Browse the [Issues](https://github.com/jsonify/ClickIt/issues) tab for tasks that need help
352+
2. **Fork & Branch** - Create a feature branch from `main` following our [Git Workflow Guide](docs/git-workflow-guide.md)
353+
3. **Make Changes** - Write clean, well-documented code following our style guidelines
354+
4. **Test Thoroughly** - Ensure your changes work on both Intel and Apple Silicon
355+
5. **Submit PR** - Use [Conventional Commits](https://www.conventionalcommits.org/) format for commit messages
356+
357+
### Areas We Need Help With
358+
- 🐛 **Bug Reports** - Found an issue? Report it with detailed steps to reproduce
359+
-**Feature Requests** - Have ideas for improvements? Open a feature request
360+
- 📝 **Documentation** - Help improve guides, tutorials, and code comments
361+
- 🌍 **Localization** - Translate ClickIt to other languages
362+
- 🧪 **Testing** - Test on different macOS versions and hardware configurations
363+
364+
### Development Setup
365+
See the [Development](#development) section below for setup instructions and our comprehensive [Git Workflow Guide](docs/git-workflow-guide.md).
366+
367+
## 🗺️ Roadmap
368+
369+
ClickIt is under active development. Here's what's coming:
370+
371+
### In Progress
372+
-**UI Optimization** - Tabbed interface with improved space utilization (v2.0)
373+
-**Timer Automation** - Schedule automatic start/stop times
374+
-**Performance Dashboard** - Real-time analytics and monitoring
375+
376+
### Planned Features
377+
- 🔄 **Click Recording** - Record and replay complex click sequences
378+
- 🎯 **Multi-Point Patterns** - Click multiple locations in sequence
379+
- 🎨 **Custom Themes** - Dark/light mode and custom color schemes
380+
- 🌍 **Localization** - Multi-language support
381+
- 📊 **Advanced Analytics** - Export statistics and performance reports
382+
- ⌨️ **Custom Hotkeys** - Configure your own keyboard shortcuts
383+
- 🔌 **AppleScript Support** - Integrate with system automation
384+
385+
Want to see a feature added? [Open a feature request](https://github.com/jsonify/ClickIt/issues/new)!
386+
387+
## 💬 Support & Community
193388

194-
## Contributing
389+
### Getting Help
390+
- 📖 **Documentation** - Check the docs in the `/docs` folder
391+
- 🐛 **Bug Reports** - [Open an issue](https://github.com/jsonify/ClickIt/issues/new) with detailed information
392+
- 💡 **Feature Requests** - Share your ideas in the Issues tab
393+
- 🤔 **Questions** - Ask in GitHub Discussions or open an issue
195394

196-
Contributions are welcome! Please read our contributing guidelines and check the Issues tab for open tasks.
395+
### Reporting Issues
396+
When reporting bugs, please include:
397+
- macOS version and processor type (Intel/Apple Silicon)
398+
- ClickIt version number
399+
- Steps to reproduce the issue
400+
- Expected vs. actual behavior
401+
- Relevant error messages or logs
197402

198-
**Before contributing**: Read the [Git Workflow Guide](docs/git-workflow-guide.md) to understand our branch strategy and release process.
403+
## 📄 License
199404

200-
## License
405+
MIT License - see [LICENSE](LICENSE) file for details.
201406

202-
MIT License - see LICENSE file for details
407+
## ⚖️ Disclaimer
203408

204-
## Disclaimer
409+
ClickIt is intended for **legitimate automation purposes only**. Users are responsible for ensuring their use complies with:
410+
- Terms of service of applications they interact with
411+
- Applicable local, state, and federal laws
412+
- Gaming platform policies and fair play guidelines
413+
- Workplace automation policies
205414

206-
This software is intended for legitimate automation purposes. Users are responsible for ensuring their use complies with the terms of service of any applications they target and applicable laws and regulations.
415+
**Use responsibly and ethically.** The developers of ClickIt are not responsible for misuse of this software.

0 commit comments

Comments
 (0)