Skip to content

Commit c9fc84e

Browse files
authored
Update badge-goreadme
Currently there is no argument as `badge-goreadme`. Docs contain it and is misleading. When copying it all people will get error.
1 parent 1e2e5c4 commit c9fc84e

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

goreadme.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@
3535
// badge-travisci: 'true'
3636
// badge-codecov: 'true'
3737
// badge-godoc: 'true'
38-
// badge-goreadme: 'true'
3938
// # Optional: Token allows goreadme to comment the PR with diff preview.
4039
// GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
4140
//
@@ -57,7 +56,7 @@
5756
// hooks:
5857
// - id: goreadme
5958
// entry: env README_FILE=README.md goreadme
60-
// args: ['-badge-goreadme=true', '-badge-godoc=true']
59+
// args: ['-badge-godoc=true']
6160
//
6261
// 3. Change README_FILE to your file name and add any flags you need in `args`.
6362
// 4. Auto-update the config to the latest repos' versions by executing `pre-commit autoupdate`

0 commit comments

Comments
 (0)