Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
morphy2k committed Apr 17, 2021
1 parent b55e091 commit 8443ab0
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Revive Action

This Action runs [Revive](https://github.com/mgechev/revive) on your [Go](https://golang.org/) code and adds optional annotations to the check.
This Action runs [Revive](https://github.com/mgechev/revive) on your [Go](https://golang.org/) code and adds annotations to the check.

## Usage

Expand All @@ -15,14 +15,14 @@ Use by building from repository
```YAML
- name: Run Revive Action by building from repository
uses: morphy2k/revive-action@v1
uses: morphy2k/revive-action@v2
```
Use by pulling pre-built image
```YAML
- name: Run Revive Action by pulling pre-built image
uses: docker://morphy/revive-action:v1
uses: docker://morphy/revive-action:v2
```
Configuration
Expand All @@ -35,11 +35,6 @@ Configuration
exclude: "file.go;foo/bar.go;./foo/bar/..."
# Path pattern (default: ./...)
path: "./foo/..."
# Name of the check (default: revive-action)
name: "Revive"
env:
# GitHub token for annotations (optional)
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## Screenshots
Expand Down
Binary file modified screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8443ab0

Please sign in to comment.