From 10d16c13d20dea6c1fda2c9cda16fe0c732342c5 Mon Sep 17 00:00:00 2001 From: Kristian Nymann Jakobsen Date: Sun, 28 Aug 2022 16:17:46 +0200 Subject: [PATCH] :pencil: Improve README --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3921ab7..bf7a61f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,24 @@ # PDF Scrub -Scrubs encrypted compressed PDF files for text watermarks and metadata. +_Scrubs encrypted compressed PDF files for text watermarks and metadata._ + +1. Decrypts the PDF if it's encrypted +2. Uncompresses the PDF +3. Removes metadata (Xpacket) +4. Tries to naively remove text based watermarks by matching objects which number of occurrences, is the same as the PDF page count. If multiple objects match, produce a pdf for each. +5. Optionally compresses the PDF again if `--no-compress` is not given as a command line argument. ## Usage ```sh -pdf_scrub path/to/file.pdf +$ pdf_scrub --help +Usage: pdf_scrub [OPTIONS] FILES... + +Arguments: + FILES... [required] + +Options: + --compress / --no-compress Compress the final pdf to reduce file size greatly [default: compress] ``` ## Dependencies