From f214d4af1cd2e21bc76e4e3ed817061a7b78921e Mon Sep 17 00:00:00 2001 From: shiftinv Date: Sat, 3 Sep 2022 19:01:07 +0200 Subject: [PATCH] docs: update readme --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 497ce65..e3acedb 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ # github-webhook-filter -A webhook filter for [Deno](https://deno.land/), that filters github webhook events before +A webhook filter for [Deno](https://deno.land/) that filters github webhook events before forwarding them to a Discord webhook, reducing noise. -Ignores common bots by default, additional options can be configured per URL: +Ignores common bots and no-op events by default, additional options can be configured per URL: -- Only forward events from specific branches -- Hide tag updates +- Only forward events from specific branches (`allowBranches`, comma-separated list) +- Ignore tag updates (`hideTags`) +- Ignore burst PR review comments in a short timespan, only showing the first x comments (`commentBurstLimit`)