Skip to content

Commit

Permalink
doc: Update animated demo to include setup step
Browse files Browse the repository at this point in the history
GIFs were generated using charmbracelet/vhs (previously
faressoft/terminalizer), then compressed at https://ezgif.com.

Both light and dark modes are now supported and the appropriate variant
of the GIF is selected automatically.
  • Loading branch information
antoineco committed Oct 11, 2024
1 parent 4cc9ac7 commit 9c9dc81
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@ docker compose up setup
docker compose up
```

![Animated demo](https://user-images.githubusercontent.com/3299086/155972072-0c89d6db-707a-47a1-818b-5f976565f95a.gif)
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/6f67cbc0-ddee-44bf-8f4d-7fd2d70f5217">
<img alt="Animated demo" src="https://github.com/user-attachments/assets/501a340a-e6df-4934-90a2-6152b462c14a">
</picture>

---

Expand Down
56 changes: 56 additions & 0 deletions demo.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# VHS - terminal recorder
# https://github.com/charmbracelet/vhs

Output demo.gif

Require docker

Set Shell bash
Set FontSize 24
Set Width 1500
Set Height 1200
Set WindowBar Rings
Set TypingSpeed 75ms
Set Theme "iTerm2 Light Background"
#Set Theme "iTerm2 Dark Background"

Hide

# BEGIN - Reset to clean state
Type "docker compose down setup"
Enter
Sleep 2s
Type "docker compose down -v"
Enter
Sleep 6s
Type "docker compose up elasticsearch -d"
Enter
Sleep 20s
Type "docker compose down"
Enter
Sleep 6s
Ctrl+L
# END - Reset to clean state

Show

Type "docker compose up setup"
Sleep 3s
Enter
Sleep 20s

Enter 2
Type "docker compose up -d"
Sleep 3s
Enter
Sleep 6s

Enter 2
Type "curl -s http://localhost:9200 -u elastic:changeme"
Sleep 3s
Enter
Sleep 12s

Enter 2
Type "👉 Open your web browser at http://localhost:5601 🚀📈"
Sleep 15s

0 comments on commit 9c9dc81

Please sign in to comment.