Skip to content

Commit

Permalink
make throttle the new default, reformat README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Gottox committed Jun 4, 2021
1 parent 9a86903 commit 9b9bd7e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -33,27 +33,27 @@ 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

### `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`
Expand Down
4 changes: 1 addition & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.'
Expand Down

0 comments on commit 9b9bd7e

Please sign in to comment.