docs: add info regarding supported events

jamesgeorge007 · Aug 28, 2020 · 3699604 · 3699604
1 parent 8481c59
commit 3699604
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,12 @@ jobs:
 
 The above job runs every half an hour, you can change it as you wish based on the [cron syntax](https://jasonet.co/posts/scheduled-actions/#the-cron-syntax).
 
+Please note that only those public events that belong to the following list show up:-
+
+- `IssueEvent`
+- `IssueCommentEvent`
+- `PullRequestEvent`
+
 You can find an example [here](https://github.com/jamesgeorge007/jamesgeorge007/blob/master/.github/workflows/update-readme.yml).
 
 _Inspired by [JasonEtco/activity-box](https://github.com/JasonEtco/activity-box)_