Merge pull request #15 from hankei6km/automated-documentation-update-…

…7237020977 docs: Automated documentation update
hankei6km · Dec 17, 2023 · 25e11bf · 25e11bf
2 parents 41a1075 + 8ea4640
commit 25e11bf
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/src/prepare-commit-msg-context/README.md b/src/prepare-commit-msg-context/README.md
@@ -17,7 +17,20 @@ Install a prepare-commit-msg hook script to /usr/local/share(the script writes t
 |-----|-----|-----|-----|
 
 
+## Install as a git hook
 
+Please copy the script separately from installing the feature.
+
+e.g.: Example of configuration in `.devcontainer.json`
+
+```jsonc
+{
+  "features": {
+      "ghcr.io/hankei6km/h6-devcontainers-features/prepare-commit-msg-context:1": {}
+  },
+  "postAttachCommand": "cp /usr/local/share/prepare-commit-msg-context/prepare-commit-msg .git/hooks/prepare-commit-msg"
+}
+```
 
 ---