Skip to content

Commit f2031c4

Browse files
committed
feat(doc): updates the readme
1 parent a27afaf commit f2031c4

1 file changed

Lines changed: 50 additions & 14 deletions

File tree

README.md

Lines changed: 50 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,76 @@
1-
# video-link-debugger
1+
# Video Link Debugger
22

3-
A CLI built with Bunli
43

5-
## Installation
4+
## Install
5+
6+
Pre-built binaries are published to the [Releases page](https://github.com/TorBox-App/video-link-debugger/releases) for every push. Pick the file matching your OS and CPU:
7+
8+
| OS | File |
9+
| --- | --- |
10+
| macOS (Apple Silicon) | `video-link-debugger-darwin-arm64` |
11+
| Linux x64 | `video-link-debugger-linux-x64` |
12+
| Linux x64 (older CPUs) | `video-link-debugger-linux-x64-baseline` |
13+
| Linux ARM64 | `video-link-debugger-linux-arm64` |
14+
| Windows x64 | `video-link-debugger-windows-x64.exe` |
15+
| Windows ARM64 | `video-link-debugger-windows-arm64.exe` |
16+
17+
The binaries are unsigned, so the first time you run one you'll see a security warning. The one-time fix per platform:
18+
19+
### macOS
20+
21+
If you see **"video-link-debugger-darwin-arm64 is damaged and can't be opened"**, that's macOS Gatekeeper rejecting the binary because it's unsigned. Run this once to remove the quarantine flag:
622

723
```bash
8-
bun install
24+
xattr -dr com.apple.quarantine ~/Downloads/video-link-debugger-darwin-arm64
25+
chmod +x ~/Downloads/video-link-debugger-darwin-arm64
26+
./video-link-debugger-darwin-arm64
927
```
1028

11-
## Development
29+
### Windows
30+
31+
If SmartScreen says **"Windows protected your PC"**, click **More info****Run anyway**.
32+
33+
You can also right-click the `.exe` → Properties → check **Unblock** → OK before launching.
34+
35+
### Linux
36+
37+
No security prompts. Just make it executable:
1238

1339
```bash
14-
bun dev -- [command]
40+
chmod +x ~/Downloads/video-link-debugger-linux-x64
41+
./video-link-debugger-linux-x64
1542
```
1643

17-
## Building
44+
## Usage
1845

1946
```bash
20-
bun run build
47+
video-link-debugger test https://example.com/video.mp4
48+
# or
49+
video-link-debugger test --link https://example.com/video.mp4
2150
```
2251

23-
## Testing
52+
### Commands
53+
54+
- `test` — Tests a video link and reports link information, network timings, seek behavior, and single- vs. multi-connection download speed.
55+
56+
## Development
2457

2558
```bash
26-
bun test
59+
bun install
60+
bun dev -- [command]
2761
```
2862

29-
## Usage
63+
### Building
3064

3165
```bash
32-
video-link-debugger hello --name World
66+
bun run build
3367
```
3468

35-
## Commands
69+
### Testing
3670

37-
- `hello` - A simple greeting command
71+
```bash
72+
bun test
73+
```
3874

3975
## License
4076

0 commit comments

Comments
 (0)