gomodoro/README.md

12 lines
542 B
Markdown

# gomodoro
A simple command line pomodoro timer
## Usage
Run `gomodoro` to start the default timer. It will print the current status on the command line.
You can customize the duration and the logging interval by using the `-duration` or `-interval` flags. Example: A 30 min timer logging every 1 min would be `gomodoro -duration 30m -interval 1m` (Not working right now)
Only one gomodoro timer can be running at a time. If you are running one in the background on another thread, you can display the status by using `gomodoro -status`