From 36996042fe508ece93c2427aecd7341d32a58b1b Mon Sep 17 00:00:00 2001 From: jamesgeorge007 Date: Fri, 28 Aug 2020 23:39:25 +0530 Subject: [PATCH] docs: add info regarding supported events --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 2624b81..f25e4ee 100644 --- 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)_