Skip to content

Commit fe271dc

Browse files
committed
FEAT: added demo file and generator
1 parent 29885c5 commit fe271dc

5 files changed

Lines changed: 81 additions & 0 deletions

File tree

docs/demo/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# URL Tracker Demo Generator
2+
3+
> How to generate a demo `.gif` file for the URL Tracker.
4+
5+
## Installation
6+
7+
> VHS requires [ttyd](https://github.com/tsl0922/ttyd) and [ffmpeg](https://ffmpeg.org/) to be installed and available on your PATH.
8+
9+
10+
[Install vhs](https://github.com/charmbracelet/vhs?tab=readme-ov-file#installation):
11+
12+
Use a package manager:
13+
14+
```bash
15+
# macOS or Linux
16+
brew install vhs
17+
18+
# Arch Linux (btw)
19+
pacman -S vhs
20+
21+
# Nix
22+
nix-env -iA nixpkgs.vhs
23+
24+
# Windows using scoop
25+
scoop install vhs
26+
```
27+
28+
## Usage
29+
30+
From the `docs/demo` folder:
31+
```bash
32+
vhs demo.tape
33+
```
34+
35+
This will generate the `docs/demo/demo.gif` file.
36+
37+
![urltracker demo](./demo.gif)
38+
39+
## Reference:
40+
41+
- [VHS Command Reference](https://github.com/charmbracelet/vhs?tab=readme-ov-file#vhs-command-reference)

docs/demo/demo.gif

164 KB
Loading

docs/demo/demo.tape

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Output demo.gif
2+
Set FontSize 16
3+
Set LineHeight 1.6
4+
Set Padding 18
5+
Set Width 800
6+
Set Height 360
7+
8+
Type "./urltracker.sh https://httpbin.org/status/200"
9+
Enter
10+
Wait
11+
Sleep 4
12+
13+
Type "clear"
14+
Enter
15+
16+
Sleep .5
17+
Type "./urltracker.sh --list list.txt"
18+
Enter
19+
Wait
20+
Sleep 4
21+
22+
Type "clear"
23+
Enter
24+
25+
Sleep .5
26+
Type "./urltracker.sh https://httpbin.org/redirect/2 --verbose"
27+
Enter
28+
Wait
29+
Sleep 6
30+
31+
Type "clear"
32+
Enter
33+
34+
Sleep 2
35+
Ctrl+C
36+
Enter

docs/demo/list.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
https://httpbin.org/status/200
2+
https://httpbin.org/redirect/2
3+
https://httpbin.org/status/404

docs/demo/urltracker.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../urltracker.sh

0 commit comments

Comments
 (0)