Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 3.03 KB

README.md

File metadata and controls

84 lines (55 loc) · 3.03 KB

EyeBreak

EyeBreak is a macOS app designed to encourage healthier screen habits and alleviate eye strain. By adhering to the scientifically supported 20/20/20 rule, EyeBreak periodically reminds users to take breaks, thereby protecting eyesight and boosting productivity.

Features

  • 20/20/20 Rule Reminders: Users are subtly reminded every 20 minutes to look at something 20 feet away for 20 seconds.
  • Intuitive Pause Feature: The app only tracks active screen time, pausing reminders automatically during periods of inactivity.
  • Customizable Intervals: Work and break durations can be personalized to fit individual preferences and working styles.
  • Non-Intrusive Notifications: Notifications are designed to be discreet, ensuring minimal disruption to focus and workflow.

Tech Stack

EyeBreak is built using modern technologies and frameworks to ensure a seamless user experience on macOS:

  • UI Framework: SwiftUI for creating a dynamic and responsive interface.
  • Programming Language: Swift, for robust and efficient application logic.
  • Notifications: UserNotifications framework for scheduling discreet break reminders.
  • System Integration: AppKit for macOS-specific functionality and IOKit for monitoring idle times.
  • Development Environment: Developed and maintained in Xcode, with Git for version control.

No external dependencies are required, simplifying setup and ensuring a lightweight application.

Getting Started

Prerequisites

  • macOS 10.15 Catalina or later

Installation

  1. Download the latest release from the Releases tab.
  2. Unzip and move EyeBreak to your Applications folder.
  3. Launch EyeBreak and adjust settings via the menu bar icon.

Usage

EyeBreak sits in the menu bar for easy access. From here, you can control the timer, customize settings, and access app information.

Building from Source

Ensure Xcode is installed on your macOS system. Clone the repository and open the .xcodeproj file in Xcode. Build the project with Cmd + B.

bashCopy code

git clone https://github.com/your-github-username/EyeBreak.git cd EyeBreak open EyeBreak.xcodeproj

Contributing

Contributions are welcome and greatly appreciated. To contribute:

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a pull request

License

Distributed under the MIT License. See LICENSE for more information.

Privacy

EyeBreak does not collect or store any personal information, respecting your privacy.

About the Project

EyeBreak was developed to help computer users maintain eye health and improve productivity. Feedback and contributions are welcome to enhance the app further.

Contact