Refresh README.md: trim to ~350 lines, fix accuracy issues, relocate long-form content to docs/

[Copilot]

README had grown to 1,156 lines, mixed high-level description with deep how-to content, and contained stale metadata. Goal: focused, skimmable README with long-form content in dedicated docs/ files.

README changes

• Drop Claude Code Review CI badge (internal noise)
• Fix Python version requirement: 3.9+ → 3.10+ (aligns with pyproject.toml requires-python = ">=3.10")
• Fix duplicate 1. numbering in intro attack list (was 1. 1. 2. 3…, now 1–7)
• Normalize all examples to sudo wifite (removed mixed python3 wifite.py usage)
• Remove duplicate "Features" / "Core Features" / "Performance Tips" sections
• Add prominent ⚠️ Legal Disclaimer section near the top
• Add documentation index table (all 11 docs/*.md files)
• Trimmed 1,156 → 351 lines; structure follows: badges → intro → legal → OS → requirements → tools → install → quick-start → features → docs index → troubleshooting → contributing → license → credits

New docs files (content relocated from README)

File	Content
docs/WPA3_GUIDE.md	WPA3 attack strategies, network types, usage examples, tool requirements
docs/ATTACK_MONITORING_GUIDE.md	TUI display layout, log format, advanced examples, performance notes, FAQ
docs/WPASEC_GUIDE.md	Full options table, upload modes, troubleshooting, privacy considerations
docs/RESUME_GUIDE.md	Session save/resume internals, management commands, troubleshooting

No content was lost — all removed README blocks now live in the appropriate docs/ file with a short summary + link back in the README.

Original prompt

Update README.md to accurately reflect the current state of wifite2

The current README.md has grown very large (1000+ lines) and mixes high-level project description with deep how-to/troubleshooting content that already lives in the docs/ directory. It also includes some content that may be stale or duplicated. The goal of this task is to refresh and tighten the README so it accurately reflects the project as it exists today, while moving long-form material into the existing docs files (or linking to them).

Investigate before writing

Before editing, audit the repo to ensure the README matches reality:

1. Version & metadata

   • Check pyproject.toml, setup.py, setup.cfg, and wifite/__init__.py (or wherever __version__ is defined) and make sure the version badge at the top of the README matches the actual current version. Update the badge if it is stale.
   • Confirm Python version requirements from pyproject.toml / setup.py and reflect them accurately (e.g. python_requires).

2. CLI flags / features

   • Look at the argument parser (likely under wifite/args.py or wifite/config.py) and verify that every flag mentioned in the README actually exists: --dual-interface, --interface-primary, --interface-secondary, --eviltwin, --pmkid-passive, --wpa3-only, --force-sae, --no-downgrade, --check-dragonblood, --wpa3-timeout, --monitor-attacks, --monitor-duration, --monitor-channel, --monitor-hop, --monitor-log, --no-tui, --wpasec, --wpasec-key, --wpasec-auto, --wpasec-url, --wpasec-timeout, --wpasec-email, --wpasec-remove, --resume, --resume-latest, --resume-id, --clean-sessions, --syscheck, --cracked, --crack, -5, -c, -b, -i, -v/-vv/-vvv, --num-deauths, --no-deauths, --no-wps, --wps-only, --pixie, --no-pixie, --bully, --first, --dict.
   • Remove or correct any flags that no longer exist; add any notable flags that are present but not mentioned.

3. Docs cross-references

   • Verify each linked file under docs/ actually exists: docs/EVILTWIN_GUIDE.md, docs/EVILTWIN_TROUBLESHOOTING.md, docs/TUI_README.md, docs/WPA3_TROUBLESHOOTING.md, docs/WPA3_DETECTION_OPTIMIZATION.md, docs/DUAL_INTERFACE_GUIDE.md, docs/DUAL_INTERFACE_EXAMPLES.md. Fix or remove broken links. List any other docs that exist but aren't linked.

4. Topics / description alignment

   • The GitHub repo description is: "Rewrite of the popular wireless network auditor, 'wifite' - original by @derv82". Repo topics include: aircrack-ng, bully, cowpatty, hashcat, hcxtools, john, kali-linux, nethunter, reaver, tshark, wifite2. The README intro should be consistent with these.

Goals for the rewritten README

• Keep it focused and skimmable — target roughly 250–400 lines, not 1000+.
• Preserve and update these sections (in this order):
  1. Badges (version, issues, forks, stars, license, Android-supported). Drop the Claude Code Review badge (internal CI noise — not relevant to end users).
  2. Short project intro (1–3 paragraphs) — what wifite2 is, that it's a maintained fork/rewrite of derv82/wifite, and the high-level list of supported attacks (WPS Pixie-Dust / online brute / NULL PIN, WPA handshake, PMKID, WPA3-SAE + transition-mode downgrade, WEP, Evil Twin).
  3. Legal / disclaimer — add a short, prominent section stating the tool is for authorized security testing/education only.
  4. Supported operating systems (Kali / Parrot / BlackArch fully; NetHunter; Ubuntu/Debian/Arch partial). Keep concise.
  5. Requirements (Python 3.9+, monitor-mode-capable adapter, root). Keep concise.
  6. Required & optional tools (keep the existing lists, but tighten descriptions).
  7. Installation (Quick install, Poetry, pip/venv, package manager, --syscheck verify). Keep concise — one short code block per method.
  8. Quick start / common usage examples (a handful of representative commands covering: default scan, WPA3, PMKID, Evil Twin, dual-interface, attack monitoring, wpa-sec upload, resume).
  9. Features overview — bulleted summary only; move long explanations of WPA3 strategies, attack-monitoring TUI internals, wpa-sec details, and resume internals into the matching docs/ files (create or extend them as appropriate) and link out from the README.
  10. Documentation index — a short section linking to all docs/*.md files that exist.
  11. Troubleshooting — keep only a brief "Common Issues" section and link to docs/ for deep dives.
  12. Contributing — short paragraph pointing to issues/PRs.
  13. License — GPL-2.0, link to LICENSE.
  14. Credits — original author @derv82, current maintainer @kimocoder, and a thank-you to contributors.

Content to move out of README (into docs/)

Move the following large blocks out of README.md and into the appropriate docs/ file (extend existing files or create new ones if needed). Replace each block in the README with...

This pull request was created from Copilot chat.