docs: document pull request permissions

agrc · Jul 10, 2024 · 5e7df86 · 5e7df86
1 parent a0c856c
commit 5e7df86
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,9 @@ Use any form of `/remind me [what] [when]`, such as:
 
 ## Sample Usage
 
+>[!TIP]
+> Add `issues: write` and `pull-requests: write` if you intend to use reminders in pull requests and issues.
+
 ```yml
 name: 'check reminders'
 
@@ -27,6 +30,7 @@ on:
 
 permissions:
   issues: write
+  pull-requests: write
 
 jobs:
   reminder: