From ebb844a3fc02d5feb72e12df8923a4f7bf6acad3 Mon Sep 17 00:00:00 2001
From: Dominic DiTaranto <me@domdit.com>
Date: Sat, 8 Nov 2025 10:01:45 -0500
Subject: [PATCH] readme

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..935da09
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# Overview
+
+Repo contains a git hook to check if the string `breakpoint` exists in any file you have staged for a commit. If the string does exist, it will provide a warning and not let you complete the commit. This is useful for python developers who are heavy offenders of commiting breakpoints (aka me).
+
+# How To
+
+1. clone this repo, preferably in ~/.config/
+2. add the path to this repo to your git hooks path: `git config --global core.hooksPath ~/.config/git/hooks/`
+3. that's it