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.