Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
StefMa authored Dec 29, 2024
1 parent 3828331 commit db737ad
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Upgrade Go Action

[![MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/StefMa/Upgrade-Go-Action/blob/main/LICENSE)
[![GitHub Release](https://img.shields.io/github/v/release/stefma/upgrade-go-action?include_prereleases)](https://github.com/StefMa/upgrade-go-action/releases/latest)

## What?

Expand All @@ -9,7 +10,7 @@ A Github Action that checks for Go upgrades and modifies the `go.mod` file accor
## How?

```yml
- uses: StefMa/Upgrade-Go-Action@main
- uses: StefMa/Upgrade-Go-Action@{latestRelease or main}
with:
base-branch: 'master' # Defaults to 'main' if absent
gh-token: {{ secrets.GITHUB_TOKEN }} # Optional. But a custom token can be provided
Expand All @@ -25,7 +26,7 @@ So, why not?
## Example
A fully working example can bn seen below.
A fully working example can be seen below.
It make sense to run this Action periodically to check for new Go versions.
```yml
Expand Down

0 comments on commit db737ad

Please sign in to comment.