From d8bd84b3f5dc733ac165798199dded3caf26a1b0 Mon Sep 17 00:00:00 2001 From: Nick Date: Fri, 18 Sep 2026 15:01:57 +0300 Subject: [PATCH] docs: make Homebrew quickstart preview-first and clarify CLI scope --- README.md | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5ca6d7c..60c4644 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Homebrew Tap for DocStripper -Homebrew tap for [DocStripper](https://github.com/KikuAI-Lab/DocStripper) - AI-powered batch document cleaner. +Homebrew tap for the [DocStripper](https://github.com/KikuAI-Lab/DocStripper) +command-line text cleaner. The CLI uses rule-based cleanup; the optional +browser AI mode is a separate interface in the upstream project. ## Installation @@ -9,16 +11,35 @@ brew tap KikuAI-Lab/docstripper brew install docstripper ``` +The [formula](Formula/docstripper.rb) currently installs upstream `v2.1.0`. +Changes on the upstream default branch do not automatically update this tap. + ## Usage +Start with existing local files and a non-writing preview: + ```bash -docstripper document.txt -docstripper file1.txt file2.docx file3.pdf +docstripper --dry-run document.txt +docstripper --dry-run file1.txt file2.docx file3.pdf ``` +> [!WARNING] +> The packaged `v2.1.0` CLI writes cleaned plain text back to the input path +> unless `--dry-run` or `--stdout` is used. This includes DOCX/PDF paths; it +> does not reconstruct those formats. Keep independent originals and do not +> run in-place cleaning on original DOCX/PDF documents. + +After reviewing the preview, run in-place cleanup only on a disposable +plain-text copy. `--stdout` avoids modifying the input but also includes +progress and statistics, so it is not a clean machine-readable export. +PDF text extraction needs `pdftotext`; see the upstream supported-format notes. + ## Documentation -See the [main repository](https://github.com/KikuAI-Lab/DocStripper) for full documentation. +See the [main repository](https://github.com/KikuAI-Lab/DocStripper) for the +browser application, source, and current CLI documentation. Check the +[packaged v2.1.0 source](https://github.com/KikuAI-Lab/DocStripper/blob/v2.1.0/tool.py) +when behavior differs from the current default branch. ## License