Skip to content

Commit a560454

Browse files
committed
feature: removed --seconds & parse --time automatically; Refreshed README.md
1 parent 50c7375 commit a560454

13 files changed

Lines changed: 37 additions & 41 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@
1414
.env
1515
.env.local
1616
**/*.bak
17+
publish_main_and_github.sh

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[package]
22
name = "dstimer"
3-
version = "1.0.0"
3+
version = "1.0.1"
44
edition = "2021"
55
description = "A dead-simple, cross-platform CLI countdown timer with color-changing progress bar and optional audio playback"
66
license = "MIT"
77
repository = "https://github.com/madLinux7/dead-simple-cli-timer"
8-
homepage = "https://github.com/madLinux7/dead-simple-cli-timer"
8+
homepage = "https://grolmes.de"
99
keywords = ["cli", "timer", "countdown", "tui", "terminal"]
1010
categories = ["command-line-utilities"]
1111
readme = "README.md"

README.md

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,36 +8,25 @@ A dead-simple, cross-platform CLI countdown timer with color-changing progress b
88

99
Written in Rust for maximum efficiency and portability.
1010

11-
![Demo with only seconds as argument](demo_args_1.gif)
11+
![Demo with 7 as argument representing the seconds](demo_args_1.gif)
1212

1313
## Features
1414

15-
- Centered, full-width **progress bar** that shifts green → yellow → red as time runs out
16-
- **Fullscreen** (default) or **inline** mode
17-
- Interactive **time entry** (HH:MM:SS)
18-
- Optional **audio file playback** when the timer completes
15+
- Automatically parses **HH:MM:SS**, **MM:SS** or just **seconds**
16+
- **Fullscreen** (default) or **--inline** mode
17+
- Full-width **progress bar**: green → yellow → red as time runs out
18+
- Interactive **time entry** (HH:MM:SS) when no arguments parsed
19+
- ♪ Optional **audio file playback** when the timer completes ♪
1920

2021
## Usage
2122

22-
### Fullscreen mode
23-
24-
```bash
25-
dstimer --seconds 300
26-
dstimer -s 90 --audio /path/to/audio.wav
27-
dstimer --time 1:30:00
28-
dstimer -t 5:00 --inline
29-
```
30-
3123
| Flag | Short | Description |
3224
|------|-------|-------------|
33-
| `--time` | `-t` | Duration in `HH:MM:SS`, `MM:SS`, or `SS` format |
34-
| `--seconds` | `-s` | Duration in seconds |
25+
| `--time` | `-t` | Default argument parsing duration in `HH:MM:SS`, `MM:SS`, or `SS` format |
3526
| `--audio` | `-a` | Path to audio file to play on finish |
3627
| `--inline` | `-i` | Inline mode (see below) |
3728
| `--silent` | | Suppress desktop notifications |
3829

39-
![Demo with seconds and audio as arguments](demo_args_2.gif)
40-
4130
### **Interactive mode** (no arguments):
4231

4332
```bash
@@ -48,18 +37,30 @@ You'll be prompted to enter a duration and an optional audio file path.
4837

4938
![demo_manual](demo_manual.gif)
5039

40+
### Fullscreen mode
41+
42+
```bash
43+
dstimer # starts interactive mode
44+
dstimer 25:00 # 25 minutes
45+
dstimer 7 # 7 seconds
46+
dstimer --time 1:30:17 # 1 hour 30 minutes 17 seconds
47+
dstimer 90 --audio /path/to/audio.wav # plays audio.wav after 90 seconds
48+
```
49+
50+
![Demo with seconds and audio as arguments](demo_args_2.gif)
51+
5152
### **Inline mode** (`--inline` / `-i`):
5253

5354
```bash
54-
dstimer -s 60 --inline
55-
dstimer --inline # interactive prompt stays inline too
55+
dstimer --inline # interactive prompt stays inline too
56+
dstimer 60 -i
5657
```
5758

5859
Renders the timer on the **current terminal line** instead of taking over the full screen. Useful for scripts, split panes, or when you want the rest of your terminal history visible.
5960

61+
![Demo inline interactive mode](demo_inline_manual.gif)
6062
![Demo inline with -i -t 00:00:07 args](demo_inline_args_1.gif)
6163
![Demo inline with -i -t 00:00:07 -a "home/linuxg/Musik/Super Survivor.flac" args](demo_inline_args_2.gif)
62-
![Demo inline interactive mode](demo_inline_manual.gif)
6364

6465
## Install
6566

@@ -125,14 +126,8 @@ And a special shoutout to [VHS](https://github.com/charmbracelet/vhs) by Charm f
125126
If you like using dstimer in your daily routine, consider buying me a coffee or sending a tip:
126127

127128
[Ko-fi](https://ko-fi.com/madlinux) ·
128-
[Bitcoin](bitcoin:bc1qv45u88hnq4xec2l8yx0qfyx88nsn63wxleln0d) ·
129-
[Monero](monero:42TKoMfUoEFbCsNdppQN4426zqCcgfTrad2YY8jQ7rPi9tRoLtuM9C4Ma1Q4f2L3pyLgpogwrJkeg2KuVADw3mj6Qzkhdgh) ·
130-
[Ethereum](ethereum:0xC251CF4323e052EdcEd397f539CC0A91b9891047) ·
131-
[Solana](solana:cMxfUJSVGc1RUS5ncdKQSv9mcCpEuDbJxQx1wg79DVt) ·
132-
[Litecoin](litecoin:ltc1qfddle7wknmgwen2scshmw42tykdxew5wc96858) ·
133-
[Cardano](web+cardano:addr1q9rsqmwf2spwnnnmth879323ssnaf92j7zj0pn6yhs23g7z8qpkuj4qza888khw0utz4rpp86j249u9y7r85f0q4z3uqxcwrsf) ·
134-
[XRP](xrp:r9ZrXVAckZ3wepeprkVdszNbXTcDT7cCNS)
129+
[Bitcoin](bitcoin:bc1qv45u88hnq4xec2l8yx0qfyx88nsn63wxleln0d)
135130

136131
---
137132

138-
Made with ♥️ by [Linus Grolmes](https://grolmes.de)
133+
Made with ♥️ by [Linus](https://grolmes.de)

demo_args_1.gif

63.6 KB
Loading

demo_args_1.tape

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Output demo_args_1.gif
66
Set Width 1200
77
Set Height 600
88

9-
Type "dstimer -s 7"
9+
Type "dstimer 7"
1010
Sleep 500ms
1111
Enter
1212
Sleep 9s

demo_args_2.gif

34.6 KB
Loading

demo_args_2.tape

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Output demo_args_2.gif
66
Set Width 1200
77
Set Height 600
88

9-
Type "dstimer -s 7 -a /Users/linuxg/Music/truisms_4_dummies.mp3"
10-
Sleep 1s
9+
Type "dstimer 7 -a /home/linuxg/Musik/MkWii_online_spectator.flac"
10+
Sleep 500ms
1111
Enter
1212
Sleep 9s

demo_inline_args_1.gif

-3.3 KB
Loading

demo_inline_args_1.tape

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Output demo_inline_args_1.gif
66
Set Width 1200
77
Set Height 400
88

9-
Type "dstimer -i -t 00:00:07"
9+
Type "dstimer -i 7"
1010
Sleep 500ms
1111
Enter
1212
Sleep 9s

0 commit comments

Comments
 (0)