chore: add warning in README

4 months ago · ca92adfca4
parent 7654140330
commit ca92adfca4
1 changed files with 3 additions and 0 deletions
--- a/git-commit-signing/README.md
+++ b/git-commit-signing/README.md
@ -9,6 +9,9 @@ tags: [helper, git]

 # git-commit-signing

+> [!IMPORTANT]  
+> This module will only work with Git version >=2.4, prior versions [do not support signing commits via SSH keys](https://lore.kernel.org/git/xmqq8rxpgwki.fsf@gitster.g/).
+
 This module downloads your SSH key from Coder and uses it to sign commits with Git.
 It requires `curl` and `jq` to be installed inside your workspace.