Update README

README.md

@@ -1,6 +1,8 @@
 # static-analysis-action
 
-GitHub action for CMake based C++ project, that runs cppcheck and clang-tidy and creates comment for PR with any issues found.
+GitHub action for CMake based C++ project, that runs cppcheck and clang-tidy, and creates comment for PR with any issues found. Created comment will contain code snippets with the issue description. When this action is run for the first time, the comment with the initial result will be created for current Pull Request. Consecutive runs will edit this comment with updated status.
+
+Note that it's possible that the amount of issues detected can make the comment's body to be greater than the GitHub's character limit per PR comment (which is 65536). In that case, the created comment will contain only the isues found to that point and the information that the limit of characters was reached.
 
 ## Workflow example
 

action.yml

@@ -7,23 +7,19 @@ inputs:
     required: true
     default: ${{ github.token }}
   pr_num:
-    description: 'Pull request number'
+    description: 'Pull request number for which the comment will be created'
     default: ${{ github.event.pull_request.number }}
     required: true
   repo:
     description: 'Repository name'
     default: ${{ github.repository }}
     required: true
-  work_dir:
-    description: 'GitHub Working directory'
-    required: true
-    default: ${{ github.workspace }}
-  exclude_dir:
-    description: 'Full path to directory which should be excluded'
   comment_title:
-    description: 'Unique title for comment'
+    description: 'Title for comment with the raport. This should be an unique name'
     default: Static analysis result
     required: true
+  exclude_dir:
+    description: 'Directory which should be excluded from the raport'
 
 runs:
   using: "docker"