Add demo videos and Wireshark debugging section to README#242
Merged
Add demo videos and Wireshark debugging section to README#242
Conversation
Adds two YouTube links showing the Android sample app in action (one plain, one with Wireshark attached to the in-app pcap-ng server), and a debugging subsection that documents how to attach Wireshark to the embedded PcapNgTcpServerPacketDumper for the Linux server/client and the Android app. The Android case explicitly calls out using the phone's Wi-Fi IP (not 127.0.0.1) and the same-subnet/firewall caveats. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the project README to improve onboarding by adding video demos and practical instructions for capturing the in-app packet dump stream with Wireshark.
Changes:
- Add a new “Demo videos” section with two YouTube links showcasing the Android sample app.
- Add a “Debugging with Wireshark” section documenting how to attach Wireshark to the embedded
PcapNgTcpServerPacketDumper. - Document host/port details and Android-specific connectivity constraints (phone Wi‑Fi IP, same subnet, firewall/AP isolation).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
GitHub strips iframes from rendered markdown so YouTube videos can't play inline; switching to the conventional thumbnail-as-clickable-link pattern (maxresdefault.jpg) gives a visual preview in a side-by-side table that opens the video on YouTube when clicked. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #242 +/- ##
============================================
- Coverage 61.69% 60.67% -1.02%
+ Complexity 231 229 -2
============================================
Files 15 15
Lines 2070 2070
Branches 315 315
============================================
- Hits 1277 1256 -21
- Misses 611 642 +31
+ Partials 182 172 -10
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Drop the misleading 'port 19000' summary; the client uses 19000 but the server uses 19001, so the intro now leaves the port to the per-target sub-bullets. - Reference PcapNgTcpServerPacketDumper.DEFAULT_PORT explicitly instead of an unqualified DEFAULT_PORT, since KAnonProxy.DEFAULT_PORT also exists in this repo (8080) and could be confused. - Note that the Android pcap server is not started with the VPN - startPcapServer() must be triggered from the app UI before Wireshark can connect. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
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.
Summary
Test plan
🤖 Generated with Claude Code