Skip to content

Commit

Permalink
Update badge-goreadme
Browse files Browse the repository at this point in the history
Currently there is no argument as `badge-goreadme`.
Docs contain it and is misleading. When copying it all people will get error.
  • Loading branch information
s4mur4i authored Oct 16, 2024
1 parent 1e2e5c4 commit c9fc84e
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions goreadme.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
// badge-travisci: 'true'
// badge-codecov: 'true'
// badge-godoc: 'true'
// badge-goreadme: 'true'
// # Optional: Token allows goreadme to comment the PR with diff preview.
// GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
//
Expand All @@ -57,7 +56,7 @@
// hooks:
// - id: goreadme
// entry: env README_FILE=README.md goreadme
// args: ['-badge-goreadme=true', '-badge-godoc=true']
// args: ['-badge-godoc=true']
//
// 3. Change README_FILE to your file name and add any flags you need in `args`.
// 4. Auto-update the config to the latest repos' versions by executing `pre-commit autoupdate`
Expand Down

0 comments on commit c9fc84e

Please sign in to comment.