feat: ADD EXIF striping #3

README.md

@@ -12,7 +12,8 @@ Simple SSG to create dynamic gallery one-pagers in your shell! Shell+Gallery
 ## Features
 
 **Available**:
-- Simple use without dependencies
+- Simple use, single dependency (exiftool)
+- Removes EXIF/GPS metadata from published images by default
 - no Javascript
 - Lightbox of image with anchor
 - Order of images via filename
@@ -21,7 +22,6 @@ Simple SSG to create dynamic gallery one-pagers in your shell! Shell+Gallery
 
 **Ideas**:
 - check file formats
-- remove exif data
 - conf file for options
 - anonymize file names
 - sections via file names
@@ -30,6 +30,17 @@ Simple SSG to create dynamic gallery one-pagers in your shell! Shell+Gallery
 
 ---
 
+## Requirements
+
+- `bash` and GNU coreutils
+- [`exiftool`](https://exiftool.org/) - `apt install libimage-exiftool-perl` (Debian/Ubuntu) or `brew install exiftool` (macOS)
+
+Docker/Podman users need nothing on the host, exiftool is baked into the image.
+
+Building with `--keep-exif` / `STRIP_EXIF=0` does not require exiftool.
+
+---
+
 ## Usage
 
 ### Docker / Podman
@@ -59,6 +70,22 @@ docker run -v $(pwd)/images:/app/images -v $(pwd)/output:/app/output localhost/s
 
 The generated gallery will be in `./output/index.html`
 
+### Metadata removal
+
+EXIF, GPS, IPTC and XMP metadata is stripped from every image by default. Only the copies
+in `./output/` are processed, your originals in `./images/` are never modified.
+
+To publish images with their metadata intact:
+
+```bash
+./build.sh --keep-exif
+# or
+STRIP_EXIF=0 ./build.sh
+
+# container
+podman run -e STRIP_EXIF=0 -v $(pwd)/images:/app/images -v $(pwd)/output:/app/output git.uphillsecurity.com/cf7/shellery:latest
+```
+
 ---
 
 ## Notes