Skip to content
This repository has been archived by the owner on Jun 10, 2022. It is now read-only.

Latest commit

 

History

History
67 lines (53 loc) · 2.09 KB

README.md

File metadata and controls

67 lines (53 loc) · 2.09 KB

Gitter chat

An Atom package to remind you to get up, move around, and take a break. Inspired by Workrave, countless articles, and my sore hips.

break screenshot


Install

Command Line

apm install break

Or through atom

Command Palette ➔ Settings View: Install Packages ➔ Break

Features

  • Customizable micro and macro break schedule. Micro are shorter breaks that occur more often. Macro are longer breaks that occur less.
  • Full screen break message that prevents you from further coding.
  • Optional notifications 1 minute before each break starts.
  • Syncs breaks across multiple atom windows.
  • Displays the current micro break count and remaining break time in the status bar. Status Bar Screenshot

Package Settings

  • Enable Micro Breaks - boolean : Enable the micro break functionality
  • Macro Break Configuration
    • Enable Notifications - boolean : Get a notification 1 minute before each macro break
    • Duration - integer : Duration in minutes of each macro break
    • Interval - integer : Time in minutes between each macro break
  • Micro Break Configuration
    • Enable Notifications - boolean : Get a notification 1 minute before each micro break
    • Duration - integer : Duration in minutes of each micro break
    • Interval - integer : Time in minutes between each micro break
    • Amount - integer : Amount of micro breaks before the macro break starts

Settings Example

break:
    enabledMicroBreaks: true
    macroBreak:
      duration: 10
      enableNotifications: false
      interval: 60
    microBreak:
      amount: 5
      duration: 5
      enableNotifications: false
      interval: 30