CringeStudios/IRC_Client
5
0
Fork 0
forked from CringeStudios/gamja
Code Pull Requests Activity

readme: document server.ping in config section

Browse Source
This commit is contained in:
Simon Ser 2021-05-31 14:48:51 +02:00
parent 2c1e4b7bea
commit a6cdd64444
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -79,11 +79,16 @@ gamja default settings can be set using a `config.json` file at the root:
```js
{
// IRC server settings.
"server": {
// WebSocket URL to connect to (string)
// WebSocket URL to connect to (string).
"url": "wss://irc.example.org",
// Channel(s) to auto-join (string or array of strings)
"autojoin": "#gamja"
// Channel(s) to auto-join (string or array of strings).
"autojoin": "#gamja",
// Interval in seconds to send PING commands (number). Set to 0 to
// disable. Enabling PINGs can have an impact on client power usage and
// should only be enabled if necessary.
"ping": 60
}
}
```