[PR #562] docs: add animated demo recording to README #550

Open
opened 2026-06-08 11:29:20 +03:00 by zhus · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/bootandy/dust/pull/562
Author: @dobestan
Created: 3/19/2026
Status: 🔄 Open

Base: masterHead: docs/add-demo-gif


📝 Commits (1)

  • cb6c805 docs: add animated demo recording to README

📊 Changes

2 files changed (+4 additions, -0 deletions)

View changed files

📝 README.md (+4 -0)
media/demo.gif (+0 -0)

📄 Description

Summary

Adds an animated terminal recording above the existing static screenshot in the Demo section. The GIF demonstrates:

  • Basic dust usage showing the full directory tree
  • dust -d 2 to limit depth
  • dust -n 5 to show only top items

Why

The existing screenshot is great for explaining the bar visualization in detail, but an animated recording lets users see dust running in real time — the instant speed and the way the tree builds is part of what makes dust compelling vs. du.

The GIF is small (333KB) and lives alongside the existing snap.png in media/.

Recorded with VHS. Demo hosted on AgentGIF.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/bootandy/dust/pull/562 **Author:** [@dobestan](https://github.com/dobestan) **Created:** 3/19/2026 **Status:** 🔄 Open **Base:** `master` ← **Head:** `docs/add-demo-gif` --- ### 📝 Commits (1) - [`cb6c805`](https://github.com/bootandy/dust/commit/cb6c805a6b90ae4381f378c7dec755504397b38c) docs: add animated demo recording to README ### 📊 Changes **2 files changed** (+4 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+4 -0) ➕ `media/demo.gif` (+0 -0) </details> ### 📄 Description ## Summary Adds an animated terminal recording above the existing static screenshot in the Demo section. The GIF demonstrates: - Basic `dust` usage showing the full directory tree - `dust -d 2` to limit depth - `dust -n 5` to show only top items ## Why The existing screenshot is great for explaining the bar visualization in detail, but an animated recording lets users see dust running in real time — the instant speed and the way the tree builds is part of what makes dust compelling vs. `du`. The GIF is small (333KB) and lives alongside the existing `snap.png` in `media/`. Recorded with [VHS](https://github.com/charmbracelet/vhs). Demo hosted on [AgentGIF](https://agentgif.com/@agentgif/dust-disk-usage/). --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
zhus added the pull-request label 2026-06-08 11:29:20 +03:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: bootandy/archived-dust#550