Skip to content

docs: make File Extractor Pro README product-ready - #52

Merged
cortega26 merged 2 commits into
mainfrom
docs/readme-product-relaunch-20261012
Oct 12, 2026
Merged

cortega26 merged 2 commits into
mainfrom
docs/readme-product-relaunch-20261012

Conversation

@cortega26

Copy link
Copy Markdown
Owner

What changed

  • Rebuilt the README around preview → select → extract → audit rather than a long feature inventory.
  • Added a fast, copyable quick start; concrete input/output walkthrough; CLI cookbook; searchable option reference; desktop shortcuts; current capabilities and explicit limitations.
  • Highlighted read-only dry run, deterministic selection, and atomic output introduced in feat: read-only extraction previews and reliable file selection #51.
  • Clarified no automatic .gitignore rules, no built-in secrets scanner, UTF-8-only extraction, and successful output overwrites.
  • Added the standard MIT LICENSE file: the README had previously declared MIT, but no file existed for GitHub license discovery.
  • Used the repository's real Tests workflow badge; no fabricated screenshot, benchmarks, install packages, or feature claims.

Verification

  • Source of truth: main@c0e819966e59cf56dd1fd430bea076b5c0885c68
  • Compared README claims against services/cli.py, services/preview.py, processor.py, services/extractor_service.py, GUI entrypoint and active CI YAML.
  • Static document checks: section anchors resolved; 32 code fence delimiters balanced; CLI flags matched actual parser options.
  • CI workflow will run the current test suite and coverage gate.

No executable code changed.

@cortega26
cortega26 merged commit d25c924 into main Oct 12, 2026
4 checks passed
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