Skip to content

Commit f815e94

Browse files
committed
maint: update README with newly rendered GIF
1 parent c6329dc commit f815e94

3 files changed

Lines changed: 10 additions & 5 deletions

File tree

Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: build install clean test list release-dry-run install-deps
1+
.PHONY: build install clean test list release-dry-run install-deps vhs
22

33
VERSION := $(shell git describe --tags 2>/dev/null || echo "dev")
44
LDFLAGS := -ldflags "-X main.version=$(VERSION)"
@@ -35,3 +35,6 @@ install-deps:
3535
release-dry-run:
3636
@echo "Running GoReleaser dry-run..."
3737
goreleaser release --snapshot --skip-publish --clean
38+
39+
vhs: build
40+
docker run --rm -v $(PWD):/vhs ghcr.io/charmbracelet/vhs vhs/basic.tape

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22

33
A simple command-line application to run a [Pomodoro](https://www.pomodorotechnique.com) timer with an animated progress bar using the [Bubble Tea](https://github.com/charmbracelet/bubbletea) framework.
44

5-
![Tiny Timer application demo](https://vhs.charm.sh/vhs-Bc93HZoHL5g7S16LmkgB9.gif)
5+
![Tiny Timer application demo](https://vhs.charm.sh/vhs-3fe8c0RQRBDBwO7ug2US2I.gif)
66

77
## Features
88

99
- Animated progress bar
1010
- Countdown timer (defaults to `25` minutes)
1111
- Customizable timer duration
12+
- Can be sent to background with standard `Ctrl-z`
13+
- Logs completed tasks to local SQLite DB
1214

1315
## Installation
1416

@@ -78,13 +80,13 @@ The following command-line flags are available:
7880
tiny-timer -count-up -title "Project planning"
7981
```
8082

81-
- **`-clean`** - Delete the SQLite database and exit. Useful for resetting your session history.
83+
- **`-clean`** - Delete the SQLite database (stored at `~/.config/tiny-timer/tiny-timer.db`) and exit. Useful for resetting your session history.
8284

8385
```bash
8486
tiny-timer -clean
8587
```
8688

87-
- **`-debug`** - Enable debug logging to `debug.log` file. All log output will be written to this file for troubleshooting.
89+
- **`-debug`** - Enable debug logging to `debug.log` file in the current directory. All log output will be written to this file for troubleshooting.
8890

8991
```bash
9092
tiny-timer -debug

vhs/basic.tape

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Env PATH "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/vhs"
1414
# Script for recording
1515

1616
Type 'tiny-timer 1 -title "Writing code"' Sleep 1s
17-
Enter Sleep 5s
17+
Enter Sleep 7s
1818

1919
Type "d" Sleep 1s
2020
Type " and tests" Sleep 3s

0 commit comments

Comments
 (0)