diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 51 |
1 files changed, 50 insertions, 1 deletions
@@ -1,4 +1,53 @@ -# License +# term-clock + +A digital clock that runs in your terminal, providing clock, alarm and timer. + +## Features + +- **Clock Mode**: Digital display of current time (24-hour format) +- **Alarm Mode**: Screen flashes at the specified time +- **Timer Mode**: Countdown timer (up to 99 minutes) + +## Installation + +```bash +go install github.com/nsfisis/term-clock@latest +``` + +## Usage + +### Clock Mode + +Displays the current time in digital format. + +```bash +term-clock clock +``` + +### Alarm Mode + +The screen flashes when the specified time is reached. Time should be specified in 24-hour format (HH:MM). + +```bash +term-clock alarm 07:00 # Alarm at 7:00 AM +``` + +### Timer Mode + +Counts down from the specified duration. Time should be specified using Go's duration format. +The screen flashes when the timer ends. + +```bash +term-clock timer 25m # 25-minute timer +term-clock timer 90s # 90-second timer +term-clock timer 1h30m # 1 hour 30 minutes timer (note: maximum 99 minutes) +``` + +## How to Exit + +Press `Ctrl+C` or type `q` to exit. + +## License The MIT License |
