#15 update README.md and action.yml (#16)

* #15 update README.md and add result.png
* #15 avoid duplicated checks on commits to open PRs
* #15 update app's name and description

Author: shenxianpeng

.github/workflows/test.yml

@@ -1,6 +1,9 @@
 name: Test action
 
-on: [push, pull_request]
+on:
+  push:
+  pull_request:
+    types: [opened]
 
 jobs:
   test:

README.md

@@ -12,7 +12,10 @@ Just create a `yml` file under your GitHub repository. For example `.github/work
 name: cpp-linter
 
 # Triggers the workflow on push or pull request events
-on: [push, pull_request]
+on:
+  push:
+  pull_request:
+    types: [opened]
 jobs:
   cpp-linter:
     name: cpp-linter
@@ -31,25 +34,24 @@ jobs:
 |------------|---------------|-------------|
 | style | 'llvm' | The style rules to use. Set this to 'file' to have clang-format use the closest relative .clang-format file. |
 | extensions | 'c,h,C,H,cpp,hpp,cc,hh,c++,h++,cxx,hxx' | The file extensions to run the action against. This is a comma-separated string. |
-| tidy-checks | 'boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-*,cppcoreguidelines-*' | A string of regex-like patterns specifying what checks clang-tidy will use.|
+| tidy-checks | 'boost-\*,bugprone-\*,performance-\*,<br>readability-\*,portability-\*,<br>modernize-\*,clang-analyzer-\*,<br>cppcoreguidelines-\*' | A string of regex-like patterns specifying what checks clang-tidy will use.|
 | repo-root | '.' | The relative path to the repository root directory. This path is relative to path designated by the runner's GITHUB_WORKSPACE environment variable. |
 | version | '10' | The desired version of the clang tools to use. Accepted options are strings which can be 6.0, 7, 8, 9, 10, 11, 12. |
 
 ### Outputs
 
 This action creates 1 output variable named `checks-failed`. Even if the linting checks fail for source files this action will still pass, but users' CI workflows can use this action's output to exit the workflow early if that is desired.
 
-### Outputs
-
-This action creates 1 output variable named `checks-failed`. Even if the linting checks fail for source files this action will still pass, but users' CI workflows can use this action's output to exit the workflow early if that is desired.
 ## Results of GitHub Actions
 
-Here is a test repository [cpp-linter-action-demo](https://github.com/shenxianpeng/cpp-linter-action-demo) which has added `cpp-linter.yml`. when an unformatted C/C++ source file was committed and create a Pull Request will automatically recognize and add warning comments.
+![github-actions bot](./demo/result.png)
+
+Behind the scenes, this is because this repository has added `test.yml` under `.github/workflows/`. When an unformatted C/C++ source file was committed and create a Pull Request will automatically recognize and add warning comments.
 
-For example, this PR [#7](https://github.com/shenxianpeng/cpp-linter-action-demo/pull/7), and warning message like below:
+Please feel free to commit code to the `test` branch of this repository or create a Pull Request to see how the process works.
 
-![github-actions bot](https://github.com/shenxianpeng/cpp-linter-action-demo/blob/master/img/result.png?raw=true)
+For example, this test PR [#6](https://github.com/shenxianpeng/cpp-linter-action/pull/5) and github-actions bot comments [link](https://github.com/shenxianpeng/cpp-linter-action/pull/5#commitcomment-55252014).
 
-Please feel free to commit code to the [demo](https://github.com/shenxianpeng/cpp-linter-action-demo) repository and create a Pull Request to see how the process works.
+## Contribution
 
 If you have any suggestions or contributions, welcome to PR [here](https://github.com/shenxianpeng/cpp-linter-action).

action.yml

@@ -1,5 +1,5 @@
-name: C/C++ code linter (clang-tidy and clang-format)
-description: Automatically checks pull requests changes with clang-tidy, clang-format and posts the comment with result.
+name: C/C++ Lint Action
+description: Automatically checks push & pull request changes with clang-format & clang-tidy, then posts a comment with faulty results.
 author: shenxianpeng
 branding:
   icon: 'check-circle'