Repository navigation
docs: lead the README with a live control demo - #72
Merged
Merged
Conversation
The top GIF now shows the core feature: the target's own cursor gliding
over its screen, the GitHub README scrolling, a click into GitHub's search
box and "WebRTC" typed on the target, all sent from the browser as USB HID
reports while the 4K60 screen streams back.
The previous UI-only clip is kept as rustkvm-ui-tour.{gif,webm} under the
interface screenshots, and docs/assets/demo/README.md describes both.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
github-actions
Bot
added
the
documentation
Rust-KVM
marked this pull request as ready for review
October 18, 2026 16:55
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by 4c · project thread
Summary
Replaces the GIF at the top of the README with a demo of the core feature: controlling the target's mouse and keyboard from the browser.
Before: the top GIF only showed UI interactions (pin sidebar, Settings, dark theme). Nothing was sent to the target.
After: the top GIF (17 s, 1280 px, 12 fps, 4.7 MB) shows the Windows target's own cursor gliding over its screen and the GitHub README scrolling down and back up. The cursor then clicks GitHub's search box, types
WebRTCand closes it with Esc. All of this is real USB HID input sent through the web UI while the 4K60 screen streams back. The 1080p WebM is 3.1 MB.How
page.mouse/page.keyboardover the<video>element. The UI turns these into absolute pointer, wheel and keyboard reports.rustkvm-ui-tour.{gif,webm}and moved under the Interface overview table.docs/assets/demo/README.mdnow describes both clips and how they were made.Testing
Docs and media only, so no Rust or frontend code changed.
cargo +nightly fmt --all: not applicablecargo +nightly clippy --workspace --release --all-targets -- -D warnings: not applicablecargo +nightly test --workspace: not applicableChecklist
Not applicable (no code changes).
🤖 Generated with Claude Code
https://claude.ai/code/session_01Nd9yeUDEYtPLNH8REFsvdC