Skip to content

docs(readme): add demo video section to both READMEs - #2

Merged
BlackHole1 merged 1 commit into
mainfrom
docs/readme-demo-video
Jun 25, 2026
Merged

BlackHole1 merged 1 commit into
mainfrom
docs/readme-demo-video

Conversation

@BlackHole1

Copy link
Copy Markdown
Member

Adds a short Demo section to both the English and Chinese READMEs so a reader can see dockswipe driving macOS dock-swipe gestures from the terminal before working through the rationale below it. The clip lives under assets/demo.mp4 and is referenced over the GitHub raw URL so it plays inline on the rendered README instead of depending on an external host.

Embed a short screen recording that shows dockswipe driving macOS
dock-swipe gestures straight from the terminal, giving readers an
immediate sense of what the tool does before they read the rationale.

The clip is committed under `assets/` and referenced over the GitHub
raw URL so it plays inline on the rendered README rather than relying
on an external host.

Signed-off-by: Kevin Cui <bh@bugs.cc>
@coderabbitai

coderabbitai Bot commented Jun 25, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3e78217d-ccf3-4918-af40-994850c4acc5

📥 Commits

Reviewing files that changed from the base of the PR and between 8cee152 and f30b6f1.

⛔ Files ignored due to path filters (1)
  • assets/demo.mp4 is excluded by !**/*.mp4
📒 Files selected for processing (2)
  • README.md
  • README.zh-CN.md

Summary by CodeRabbit

  • Documentation
    • Added a new “Demo” section to the README with a brief description and an embedded demo video.
    • Added a corresponding “演示” section to the Chinese README, including a demo video showing the app in action.

Walkthrough

The English and Chinese README files each add a new Demo/演示 section. Both sections include descriptive text about terminal-driven dock-swipe gestures and embed a demo video sourced from the repository asset.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the required type(scope): subject format and accurately summarizes the README demo video update.
Description check ✅ Passed The description clearly matches the documentation changes by describing the new demo section and embedded video in both READMEs.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/readme-demo-video

Comment @coderabbitai help to get the list of available commands.

@BlackHole1
BlackHole1 merged commit 3b2a007 into main Jun 25, 2026
2 of 3 checks passed
@BlackHole1
BlackHole1 deleted the docs/readme-demo-video branch June 25, 2026 11:15
BlackHole1 added a commit that referenced this pull request Jun 25, 2026
Adds a short Demo section to both the English and Chinese READMEs so a
reader can see dockswipe driving macOS dock-swipe gestures from the
terminal before working through the rationale below it. The clip lives
under `assets/demo.mp4` and is referenced over the GitHub raw URL so it
plays inline on the rendered README instead of depending on an external
host.

Signed-off-by: Kevin Cui <bh@bugs.cc>
BlackHole1 added a commit that referenced this pull request Jun 25, 2026
Adds a short Demo section to both the English and Chinese READMEs so a
reader can see dockswipe driving macOS dock-swipe gestures from the
terminal before working through the rationale below it. The clip lives
under `assets/demo.mp4` and is referenced over the GitHub raw URL so it
plays inline on the rendered README instead of depending on an external
host.

Signed-off-by: Kevin Cui <bh@bugs.cc>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant