README.md: Add FAQ about using FD as a pre-commit hook

tweag · Jul 31, 2023 · 98e40d1 · 98e40d1
1 parent 04c5b69
commit 98e40d1
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -596,3 +596,19 @@ fawltydeps --code -
 # FawltyDeps waits for code on stdin; paste from your clipboard,
 # then press Ctrl+D to signal EOF (end-of-file).
 ```
+
+### Can I use FawltyDeps as a pre-commit hook?
+
+Yes! Assuming that you already use the [pre-commit](https://pre-commit.com)
+tool, you can add something like this to your project's
+`.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/tweag/FawltyDeps
+    rev: v0.12.1
+    hooks:
+      - id: check
+        args:
+          - --detailed
+```