diff --git a/README.md b/README.md index cb1e2fdc..96b5bbb4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # hide-comment-action [![ts](https://github.com/int128/hide-comment-action/actions/workflows/ts.yaml/badge.svg)](https://github.com/int128/hide-comment-action/actions/workflows/ts.yaml) -This is an action to hide comment(s) in a pull request. +This is an action to hide (minimize) comments in a pull request. + +![screenshot](https://user-images.githubusercontent.com/321266/128599297-0edb5a92-7c83-42c7-9f8a-8946b4049ed3.png) ## Getting Started @@ -9,8 +11,7 @@ To run this action: ```yaml jobs: - build: - runs-on: ubuntu-latest + hide: steps: - uses: int128/hide-comment-action@v1 with: @@ -25,7 +26,9 @@ This action hides comment(s) which matches to the following filters: - The author of comment is one of `authors` - The comment is not hidden -It hides all comments created by `github-actions` by default. +It hides all comment(s) created by `github-actions` by default. + +It hides comment(s) only if triggered on a pull request event. ## Inputs