aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authornsfisis <nsfisis@gmail.com>2025-12-03 03:19:52 +0900
committernsfisis <nsfisis@gmail.com>2025-12-03 03:20:51 +0900
commitc865d2d9d41719e56bc7f6e4eca6078ee402c291 (patch)
treec47618105f36f9e5174223098a7473b90285da57 /README.md
parentc3117d169482f888156a034526874eb268bb2d71 (diff)
downloadterm-clock-c865d2d9d41719e56bc7f6e4eca6078ee402c291.tar.gz
term-clock-c865d2d9d41719e56bc7f6e4eca6078ee402c291.tar.zst
term-clock-c865d2d9d41719e56bc7f6e4eca6078ee402c291.zip
docs: Add screenshot to READMEHEADmain
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 92300bd..75c081a 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
A digital clock that runs in your terminal, providing clock, alarm and timer.
+![screenshot](assets/screenshot.png)
+
## Features
- Clock Mode: Digital display of current time (24-hour format)
@@ -31,6 +33,8 @@ or
$ term-clock
```
+![clock](assets/clock.gif)
+
### Alarm Mode
The screen flashes when the specified time is reached. Time should be specified in 24-hour format (HH:MM).
@@ -39,6 +43,8 @@ The screen flashes when the specified time is reached. Time should be specified
$ term-clock alarm 07:00 # Alarm at 7:00 AM
```
+![alarm](assets/alarm.gif)
+
### Timer Mode
Counts down from the specified duration. Time should be specified using Go's duration format.
@@ -50,6 +56,8 @@ $ term-clock timer 90s # 90-second timer
$ term-clock timer 1h30m # 1 hour 30 minutes timer (note: maximum 99 minutes)
```
+![timer](assets/timer.gif)
+
### Countdown Mode
Counts down from the specified number of seconds to zero, displaying the remaining seconds.
@@ -63,6 +71,8 @@ $ term-clock countdown 9999 # Countdown from 9999 seconds
Note: Maximum supported duration is 9999 seconds.
+![countdown](assets/countdown.gif)
+
## How to Exit
Press `Ctrl+C` or type `q` to exit.