Skip to content

Commit

Permalink
📝 Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
nymann committed Aug 28, 2022
1 parent 1c60394 commit 10d16c1
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 10d16c1

Please sign in to comment.