Merge pull request #48 from reviewdog/update-documents-for-permissions

add documents for the permissions
reviewdog · Dec 26, 2023 · cdd4424 · cdd4424
2 parents 4daff13 + ded142e
commit cdd4424
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -52,6 +52,20 @@ inputs:
     default: 'true'
 ```
 
+## Required Permissions
+
+The action requires the following permissions:
+
+```yaml
+permissions:
+  contents: read
+  checks: write
+  issues: write
+  pull-requests: write
+```
+
+See [Assigning permissions to jobs](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs) for more details.
+
 ## Usage Example
 
 ```yaml