Skip to content

Commit

Permalink
Update readme according to godoc
Browse files Browse the repository at this point in the history
  • Loading branch information
posener committed Sep 28, 2021
1 parent 175a7d3 commit 4f46da4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The package can be used as a command line tool and as Github action, described b
Github actions can be configured to update the README file automatically every time it is needed.
Below there is an example that on every time a new change is pushed to the main branch, the
action is trigerred, generates a new README file, and if there is a change - commits and pushes
it to the main branch. In pull requests that affect the README content, if the `github-token`
it to the main branch. In pull requests that affect the README content, if the `GITHUB_TOKEN`
is given, the action will post a comment on the pull request with changes that will be made to
the README file.

Expand Down Expand Up @@ -44,7 +44,7 @@ jobs:
badge-godoc: 'true'
badge-goreadme: 'true'
# Optional: Token allows goreadme to comment the PR with diff preview.
github-token: '${{ secrets.GITHUB_TOKEN }}'
GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
```

Use as a command line tool
Expand Down

0 comments on commit 4f46da4

Please sign in to comment.