From 9b9bd7eaebf0e167e6342f443903f3e98f7733b5 Mon Sep 17 00:00:00 2001 From: Enno Boland Date: Fri, 4 Jun 2021 16:16:16 +0200 Subject: [PATCH] make throttle the new default, reformat README.md --- README.md | 16 ++++++++-------- action.yml | 4 +--- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index fbd5fe4..acc2ee4 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,13 @@ response from a given user ### `server` The hostname of the IRC server - default: 'irc.libera.chat' - required: true + + default: 'irc.libera.chat' ### `port` The port number of the IRC server - default: 6697 - required: true + + default: 6697 ### `channel` **Required** IRC channel that will receive the messages @@ -33,12 +33,12 @@ IRC SASL password ### `notice` Use NOTICE instead of PRIVMSG -default: false + default: false ### `tls` Use TLS to connect to the IRC server -default: true + default: true ### `response_allow_from` Comma seperated list of authenticated accounts allowed to response to an action @@ -46,14 +46,14 @@ Comma seperated list of authenticated accounts allowed to response to an action ### `response_timeout` Timeout to wait for a response in seconds -default: 60 + default: 60 ### `excess_flood` Prevention strategy for excess flooding a channel Either "throttle" or "truncate". * `truncate`: cuts off the message after 3 lines. * `throttle`: sends only 1 line per second. -default: "truncate" + default: "throttle" ### `debug` diff --git a/action.yml b/action.yml index c4adba4..191436f 100644 --- a/action.yml +++ b/action.yml @@ -6,11 +6,9 @@ inputs: server: description: 'The hostname of the IRC server' default: 'irc.libera.chat' - required: true port: description: 'The port number of the IRC server' default: 6697 - required: true channel: description: 'IRC channel that will receive the messages' required: true @@ -46,7 +44,7 @@ inputs: Prevention strategy for excess flooding a channel Either "throttle" or "truncate". * `truncate`: cuts off the message after 3 lines. * `throttle`: sends only 1 line per second. - default: "truncate" + default: "throttle" required: false debug: description: 'Enables verbose output.'