Bläddra i källkod

Merge pull request #658 from w0rmr1d3r/update_pre-commit_example

Update readme
Ramon 4 år sedan
förälder
incheckning
acffe44440
1 ändrade filer med 5 tillägg och 7 borttagningar
  1. 5 7
      README.md

+ 5 - 7
README.md

@@ -37,7 +37,6 @@ Gitleaks is a SAST tool for detecting hardcoded secrets like passwords, api keys
 - json, sarif, and csv reporting
 - json, sarif, and csv reporting
 - Private repo scans using key or password based authentication
 - Private repo scans using key or password based authentication
 
 
-
 ### Installation
 ### Installation
 Gitleaks can be installed using Homebrew, Docker, or Go. Gitleaks is also available in binary form for many popular platforms and OS types on the [releases page](https://github.com/zricethezav/gitleaks/releases). In addition, Gitleaks can be implemented as a pre-commit hook directly in your repo.
 Gitleaks can be installed using Homebrew, Docker, or Go. Gitleaks is also available in binary form for many popular platforms and OS types on the [releases page](https://github.com/zricethezav/gitleaks/releases). In addition, Gitleaks can be implemented as a pre-commit hook directly in your repo.
 
 
@@ -82,10 +81,10 @@ Sample `.pre-commit-config.yaml`
 # The revision doesn't get updated manually
 # The revision doesn't get updated manually
 # check this https://github.com/zricethezav/gitleaks/releases
 # check this https://github.com/zricethezav/gitleaks/releases
 # to see if there are newer versions
 # to see if there are newer versions
--   repo: https://github.com/zricethezav/gitleaks
-    rev: v7.6.0
-    hooks:
-    -   id: gitleaks
+- repo: https://github.com/zricethezav/gitleaks
+  rev: v7.6.1
+  hooks:
+    - id: gitleaks
 ```
 ```
 
 
 ### Usage and Options
 ### Usage and Options
@@ -138,7 +137,6 @@ This scans the entire history of tests/secrets and logs leaks as they are encoun
 gitleaks --repo-url=https://github.com/my-insecure/repo -v
 gitleaks --repo-url=https://github.com/my-insecure/repo -v
 ```
 ```
 
 
-
 #### Basic repo-url scan output to a report:
 #### Basic repo-url scan output to a report:
 If you want the report in sarif or csv you can set the `-f/--format` option
 If you want the report in sarif or csv you can set the `-f/--format` option
 ```bash
 ```bash
@@ -303,4 +301,4 @@ These users are [sponsors](https://github.com/sponsors/zricethezav) of gitleaks:
 - [Henry Sachs](https://github.com/henrysachs)
 - [Henry Sachs](https://github.com/henrysachs)
 
 
 #### Logo Attribution
 #### Logo Attribution
-The Gitleaks logo uses the Git Logo created <a href="https://twitter.com/jasonlong">Jason Long</a> is licensed under the <a href="https://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution 3.0 Unported License</a>.
+The Gitleaks logo uses the Git Logo created by [Jason Long](https://twitter.com/jasonlong) and is licensed under the [Creative Commons Attribution 3.0 Unported License](https://creativecommons.org/licenses/by/3.0/).