Skip to content

Commit 3e1f99f

Browse files
committed
Add a one-line quickstart and a demo recording script to the README
Put a zero-install pipx/uvx one-liner above the fold so a visitor can try a scan in seconds, and pull the output preview up next to it. Add assets/demo.tape so the static preview can be replaced with an animated VHS demo GIF.
1 parent 2a13ebc commit 3e1f99f

2 files changed

Lines changed: 46 additions & 4 deletions

File tree

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,18 @@
99

1010
</div>
1111

12+
> **Scan any domain you are authorised to assess in one line. Nothing to install:**
13+
14+
```bash
15+
pipx run sentineldeck scan example.com # or: uvx sentineldeck scan example.com
16+
```
17+
18+
Prefer a permanent install? `pip install -U sentineldeck`, then `sentineldeck scan example.com`.
19+
20+
<p align="center">
21+
<img src="assets/cli.svg" alt="SentinelDeck command-line output" width="720">
22+
</p>
23+
1224
<table>
1325
<tr>
1426
<td><b>Testing</b></td>
@@ -60,10 +72,6 @@ It is built for the people who need that picture fast: an agency qualifying a
6072
prospect, a consultant producing a client report, or a small team checking its
6173
own footprint.
6274

63-
<p align="center">
64-
<img src="assets/cli.svg" alt="SentinelDeck command-line home screen" width="720">
65-
</p>
66-
6775
## Contents
6876

6977
- [Features](#features)

assets/demo.tape

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# SentinelDeck animated demo.
2+
#
3+
# Generate the GIF with charmbracelet/vhs (https://github.com/charmbracelet/vhs):
4+
#
5+
# vhs assets/demo.tape -> writes assets/demo.gif
6+
#
7+
# Then swap the static assets/cli.svg in README.md for assets/demo.gif.
8+
# Requires sentineldeck on PATH (pip install -e . or pipx install sentineldeck)
9+
# and network access for the live scan.
10+
11+
Output assets/demo.gif
12+
13+
Set Shell "bash"
14+
Set FontSize 16
15+
Set Width 1200
16+
Set Height 760
17+
Set Padding 24
18+
Set Theme "Catppuccin Mocha"
19+
Set TypingSpeed 60ms
20+
21+
# 1. The branded home screen (instant, no network).
22+
Type "sentineldeck"
23+
Enter
24+
Sleep 3s
25+
26+
# 2. A real passive scan turning a domain into a grade and findings.
27+
Type "sentineldeck scan example.com"
28+
Enter
29+
Sleep 8s
30+
31+
# 3. Render a client-ready HTML report.
32+
Type "sentineldeck scan example.com --html report.html"
33+
Enter
34+
Sleep 5s

0 commit comments

Comments
 (0)