From 333bf29f6271a0d94dc63be2aae0c07f24497d80 Mon Sep 17 00:00:00 2001
From: Maximilian Held <info@maxheld.de>
Date: Sun, 19 Jan 2025 22:26:35 +0100
Subject: [PATCH] add docs

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

diff --git a/README.md b/README.md
index a855c50..a209409 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,8 @@ devops package
 
 ## Installation
 
+Run this once to set up the git hooks.
+
 ```sh
 cp -f muggle/post-checkout.sample .git/modules/muggle/hooks/post-checkout
 chmod +x .git/modules/muggle/hooks/post-checkout
@@ -13,3 +15,10 @@ cp -f muggle/post-checkout.sample .git/modules/muggle/hooks/post-rewrite
 chmod +x .git/modules/muggle/hooks/post-rewrite
 sh muggle/install.sh
 ```
+
+After this, muggle is installed.
+All future necessary updates will happen automatically,
+whenever you update the muggle submodule.
+
+You can also always rerun the `muggle/install.sh` script;
+it is idempotent.