Merge pull request #118 from Sayrus/fix-documentation-samples

docs(pre-receive): fix filenames and python version
GitGuardian · Oct 25, 2021 · f3c480e · f3c480e
2 parents 88fa8bb + 1fb057b
commit f3c480e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -626,7 +626,7 @@ $ git push --push-option=breakglass
 
 1. This pre-receive hook requires the host machine to have python>=3.8 and pip installed
 1. Install ggshield from pip: `pip install ggshield`
-1. Move `pre-receive-python.sample` to `.git/hooks/pre-receive` or to your provider's git hook directory
+1. Move `pre-receive.sample` to `.git/hooks/pre-receive` or to your provider's git hook directory
 
    - https://docs.gitlab.com/ee/administration/server_hooks.html
 
@@ -653,7 +653,7 @@ $ git push --push-option=breakglass
 [**pre-receive-docker.sample**](doc/pre-receive-docker.sample)
 
 1. This pre-receive hook requires the host machine to have docker installed.
-1. Move `pre-receive.sample` to `.git/hooks/pre-receive`
+1. Move `pre-receive-docker.sample` to `.git/hooks/pre-receive`
 1. Do not forget to `chmod +x .git/hooks/pre-receive`
 1. either set an environment variable machine wide `GITGUARDIAN_API_KEY` or set it in the `.git/hooks/pre-receive` as instructed in the sample file.
 

diff --git a/doc/pre-receive.sample b/doc/pre-receive.sample
@@ -1,10 +1,10 @@
 #!/bin/sh
 # ggshield as a pre-commit hook
 # Prequirements:
-# python >= 3.6, pip
+# python >= 3.8, pip
 # Installation instructions:
 # Run: pip install ggshield
-# Move `pre-receive-python.sample` to `.git/hooks/pre-receive`
+# Move `pre-receive.sample` to `.git/hooks/pre-receive`
 # Do not forget to `chmod +x .git/hooks/pre-receive`
 # either set an environment variable machine wide `GITGUARDIAN_API_KEY`
 # or uncomment and insert your key in the following line