https://github.com/nadeesha/breaktime

Timer-based screen locker for OS X inspired by Breaktime app (http://breaktimeapp.com/)
https://github.com/nadeesha/breaktime

Last synced: 4 days ago
JSON representation

Timer-based screen locker for OS X inspired by Breaktime app (http://breaktimeapp.com/)

• Host: GitHub
• URL: https://github.com/nadeesha/breaktime
• Owner: nadeesha
• License: mit
• Created: 2015-04-06T08:49:44.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-12-17T23:27:27.000Z (almost 6 years ago)
• Last Synced: 2024-04-22T14:23:46.229Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 14.6 KB
• Stars: 39
• Watchers: 2
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Breaktime

Breaktime is a CLI app inspired by [Breaktime](http://breaktimeapp.com/). The app encourages you to take breaks from your work and device by locking your screen after a set time.

## Install

`npm i -g breaktime`

## Usage

`breaktime [amount unit] [-say]`

Running `breaktime` on your console will give you the default timer of 45 minutes. To set a custom timer, simply type it out after `breaktime`: e.g. `breaktime 20 minutes`. The app uses moment to parse the time, so most formats are supported.

The `-say` option will tell you when there are 5 seconds remaining using the built-in text-to-speech of your device.

## Examples

```sh

breaktime 45 minutes

breaktime 2 hours -say

breaktime 10 seconds

```

## Contributing

Feel free to submit an issue to bring up a bug or suggest an improvement, or to submit a pull request with your improvement implemented.