From 19ad37073b44f9646f71c47ecbe189007fbbf102 Mon Sep 17 00:00:00 2001
From: Thibaut Decombe <68703331+UnknownPlatypus@users.noreply.github.com>
Date: Mon, 22 Jan 2024 13:04:13 +0100
Subject: [PATCH] Add pre-commit integration docs (#589)

Hey !

Following the addition of [pre-commit
support](https://github.com/shssoichiro/oxipng/issues/429), I've updated
the docs with a small section to reflect that.

I've added this just above the [trunk
integration](https://github.com/shssoichiro/oxipng/pull/486) section.
Because pre-commit is open source while trunk is proprietary, it felt
more appropriate to promote this option.

Let me know if you want me to make any changes.

Cheers
---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index b6cd58d5..262bedc9 100644
--- a/README.md
+++ b/README.md
@@ -65,6 +65,20 @@ matter of preference. Multiple short options can be combined together, e.g.:
 `-savvo6` is equivalent to to `--strip safe --alpha --verbose --verbose --opt 6`.
 Note that all options are case-sensitive.
 
+## Git integration via [pre-commit]
+
+Add this to your `.pre-commit-config.yaml`
+
+```yaml
+repos:
+  - repo: https://github.com/shssoichiro/oxipng
+    rev: v9.0.0
+    hooks:
+      - id: oxipng
+        args: ["-o", "4", "--strip", "safe", "--alpha"]
+```
+[pre-commit]: https://pre-commit.com/
+
 ## Git integration via [Trunk]
 
 [Trunk] is an extendable superlinter which can be used to run `oxipng` to automatically optimize `png`s when committing them into a git repo, or to gate any `png`s being added to a git repo on whether they are optimized. The [trunk] oxipng integration is [here](https://github.com/trunk-io/plugins/tree/main/linters/oxipng).