Fix README.md accuracy: correct version, CLI flags, and dead links#458
Fix README.md accuracy: correct version, CLI flags, and dead links#458
Conversation
kimocoder
commented
Mar 6, 2026
kimocoder
commented
- Version badge: 2.9.9 -> 2.9.9-beta to match pyproject.toml/config.py
- Remove false signal jammer claim (no such feature in codebase)
- Fix --classic -> --no-tui (actual flag name)
- Fix --deauth-count -> --num-deauths (actual flag name)
- Fix --pmkid-only -> --pmkid (actual flag name)
- Fix --first -> -first (actual flag name)
- Remove dead doc links: ATTACK_MONITORING_GUIDE.md, WPA3_TOOL_REQUIREMENTS.md, DUAL_INTERFACE_TROUBLESHOOTING.md (files don't exist)
- Add existing WPA3_DETECTION_OPTIMIZATION.md to docs section
- Remove POETRY.md reference (file doesn't exist)
- Consolidate Python version text to match pyproject.toml (>=3.9, up to 3.14)
- Fix Android version claim to avoid citing unreleased versions
- Version badge: 2.9.9 -> 2.9.9-beta to match pyproject.toml/config.py - Remove false signal jammer claim (no such feature in codebase) - Fix --classic -> --no-tui (actual flag name) - Fix --deauth-count -> --num-deauths (actual flag name) - Fix --pmkid-only -> --pmkid (actual flag name) - Fix --first -> -first (actual flag name) - Remove dead doc links: ATTACK_MONITORING_GUIDE.md, WPA3_TOOL_REQUIREMENTS.md, DUAL_INTERFACE_TROUBLESHOOTING.md (files don't exist) - Add existing WPA3_DETECTION_OPTIMIZATION.md to docs section - Remove POETRY.md reference (file doesn't exist) - Consolidate Python version text to match pyproject.toml (>=3.9, up to 3.14) - Fix Android version claim to avoid citing unreleased versions https://claude.ai/code/session_01BuJkuNG6nC21Vcgb5xDCZM
- Fix malformed bullet point (*** -> * **) in Evil Twin guide entry - Add reference to existing DUAL_INTERFACE_EXAMPLES.md doc https://claude.ai/code/session_01BuJkuNG6nC21Vcgb5xDCZM
There was a problem hiding this comment.
Pull request overview
Updates README.md to better reflect the current project state and CLI/documentation surface area (version, flags, and available docs), reducing user confusion and removing references to non-existent features/files.
Changes:
- Update README version badge to
2.9.9-betato match the project version. - Correct several CLI flag references and remove links to missing documentation files.
- Adjust platform/version claims (Android, Python) for better accuracy.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Speed Optimization | ||
| * **PMKID first** - Try `--pmkid-only` for fastest WPA/WPA2 attacks (no clients needed) | ||
| * **PMKID first** - Try `--pmkid` for fastest WPA/WPA2 attacks (no clients needed) |
There was a problem hiding this comment.
--pmkid is implemented as “PMKID only” (it disables other WPA/WPS attacks), but the text says “PMKID first”, which implies it will try PMKID and then fall back to other methods. Reword this to reflect that --pmkid restricts attacks to PMKID capture only, so users don’t accidentally reduce their success rate.
| * **PMKID first** - Try `--pmkid` for fastest WPA/WPA2 attacks (no clients needed) | |
| * **PMKID-only mode** - Use `--pmkid` to restrict attacks to PMKID capture only (disables other WPA/WPS methods and may reduce overall success rate) |
| * **[Evil Twin Attack Guide](docs/EVILTWIN_GUIDE.md)** - Complete guide to Evil Twin attacks | ||
| * Hardware and software requirements |
There was a problem hiding this comment.
Markdown formatting: this line begins with *** (no space after the list marker), so it won’t render as a proper list item and may be interpreted as bold/italic emphasis instead. Add a space after the bullet (e.g., * **[Evil Twin Attack Guide]...) to keep the documentation list formatting consistent.
| * **[WPA3 Detection Optimization](docs/WPA3_DETECTION_OPTIMIZATION.md)** - WPA3 detection and optimization details | ||
|
|
||
| * **[Dual Interface Examples](docs/DUAL_INTERFACE_EXAMPLES.md)** - Dual wireless interface usage examples |
There was a problem hiding this comment.
PR description mentions adding a “Dual Interface Examples” doc link, but the README’s Documentation section doesn’t currently include it. If that addition is intended, add the missing bullet/link here (the file docs/DUAL_INTERFACE_EXAMPLES.md exists).
| * As we moved from older python and changed to fully support and run on `python3.14` | ||
| * `python3` (Python 3.9+, tested up to Python 3.14) | ||
| * [`Iw`](https://wireless.wiki.kernel.org/en/users/documentation/iw): For identifying wireless devices already in Monitor Mode. | ||
| * [`Ip`](https://packages.debian.org/buster/net-tools): For starting/stopping wireless devices. |
There was a problem hiding this comment.
The Ip dependency link points to Debian net-tools, but ip is provided by iproute2 (and the codebase’s dependency metadata for Ip also references iproute2). Update this link/text to avoid directing users to the wrong package.
| * [`Ip`](https://packages.debian.org/buster/net-tools): For starting/stopping wireless devices. | |
| * [`ip` (from `iproute2`)](https://packages.debian.org/buster/iproute2): For starting/stopping wireless devices. |
| * **Position matters** - Get closer to target networks for better signal strength | ||
| * **Choose the right channel** - Use `-c <channel>` to focus on specific channels | ||
| * **Limit concurrent attacks** - Use `--first 5` to attack only the strongest targets first | ||
| * **Limit concurrent attacks** - Use `-first 5` to attack only the strongest targets first |
There was a problem hiding this comment.
This example uses -first 5, but the CLI also supports the conventional long flag --first (and -first is an unusual “multi-char short” option). Consider switching back to --first 5 (or mentioning both) to reduce user confusion.
| * **Limit concurrent attacks** - Use `-first 5` to attack only the strongest targets first | |
| * **Limit concurrent attacks** - Use `--first 5` to attack only the strongest targets first |
