diff --git a/README.md b/README.md index ee1a39b..728752f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,56 @@ # PDFtrim -Command line utilitka pre orezanie PDF podla obsahu, odstrani biele miesto na strane. \ No newline at end of file +Command line utilitka pre orezanie PDF podľa obsahu (odstráni biele okraje na stranách). + +## Inštalácia + +### 1) Požiadavky + +- Go 1.23+ (`go version`) + +### 2) Stiahnutie závislostí + +V priecinku projektu spusti: + +```bash +go mod tidy +``` + +### 3) Build binárky + +```bash +go build -o pdftrim +``` + +Na Windows môžeš použiť: + +```powershell +go build -o pdftrim.exe +``` + +## Použitie + +Program očakáva 1. argument: vstupný `subor.pdf`. + +```bash +./pdftrim subor.pdf +``` + +Alebo bez buildu: + +```bash +go run . subor.pdf +``` + +## Výstup + +- Vytvorí sa nový súbor v rovnakom priečinku: + - `subor-trimmed.pdf` +- Pôvodný PDF súbor ostáva nezmenený. + +Príklad: + +```bash +./pdftrim faktura.pdf +# výstup: faktura-trimmed.pdf +```