Skip to content

Commit eb32952

Browse files
committed
docs: gif recording script for README.md
1 parent 665ae31 commit eb32952

2 files changed

Lines changed: 30 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
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)
6+
57
## Features
68

79
- Animated progress bar
@@ -120,7 +122,7 @@ goreleaser release --snapshot --skip-publish
120122
### Record demo video with VHS
121123

122124
```nushell
123-
docker run --rm -v ($env.PWD):/vhs ghcr.io/charmbracelet/vhs new my.tape
125+
docker run --rm -v ($env.PWD):/vhs ghcr.io/charmbracelet/vhs vhs/basic.tape
124126
```
125127

126128
## License

vhs/basic.tape

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Configuration
2+
3+
Output vhs/basic.gif
4+
5+
Require tiny-timer
6+
7+
Set Shell "bash"
8+
Set FontSize 32
9+
Set Width 1200
10+
Set Height 600
11+
12+
Env PATH "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/vhs"
13+
14+
# Script for recording
15+
16+
Type 'tiny-timer 1 -title "Writing code"' Sleep 1s
17+
Enter Sleep 5s
18+
19+
Type "d" Sleep 1s
20+
Type " and tests" Sleep 3s
21+
Enter Sleep 5s
22+
23+
Type "h" Sleep 3s
24+
Enter Sleep 2s
25+
26+
Type "q"
27+
Sleep 4s

0 commit comments

Comments
 (0)