From d77b9d326dde90670ae95c1ba308080cfd3a7e9f Mon Sep 17 00:00:00 2001
From: pvincent <pvincent@artcode.re>
Date: Sat, 22 Aug 2026 19:15:12 +0400
Subject: [PATCH] hooks.d/after-upgrade documentation

---
 doc/index.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/doc/index.md b/doc/index.md
index d4ac7cd..307f827 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -8,7 +8,28 @@
 
 Rk: useful when timezone has changed or ghostty command has been installed aftwerwards
 
-`miaou-bash --initiate`
+`sudo miaou-bash "$MIAOU_BASH_DIR"/lib/initiate.bash`
+
+## debug, use of MIAOU_DEBUG
+
+```bash
+MIAOU_DEBUG=true miaou-bash <<EOF
+echo this is still fine
+false
+echo SHOULD NOT APPEAR
+EOF
+```
+
+## hooks.d/after-upgrade
+
+To launch optional scripts after 'upgrade', you can create any hook regarding:
+
+1. script should be stored in "$MIAOU_BASH_DIR/hooks.d/
+2. script should be named with prefix 'after-upgrade', example: `after-upgrade-1.bash`
+3. script should be executable, ie: `chmod +x after-upgrade-1.bash`
+
+Rk: hooks.d/ respects natural order,
+ie: `after-upgrade-0.bash` will perform before `after-upgrade-1.bash`
 
 ## IDEA