Skip to content

Commit 0d1dfd2

Browse files
committed
Update webhook instructions
1 parent c7263b7 commit 0d1dfd2

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -107,16 +107,23 @@ The `ircOptions` object is passed directly to irc-upd ([available options](https
107107
To retrieve a discord channel ID, write `\#channel` on the relevant server – it should produce something of the form `<#1234567890>`, which you can then use in the `channelMapping` config.
108108

109109
### Webhooks
110-
Webhooks allow nickname and avatar override, so messages coming from IRC will appear almost as regular Discord messages.
110+
Webhooks lets you override nicknames and avatars, so messages coming from IRC
111+
can appear as regular Discord messages:
111112

112-
See [here (part 1 only)](https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks) to create a webhook for a channel.
113+
![discord-webhook](http://i.imgur.com/lNeJIUI.jpg)
113114

114-
Example result:
115+
To enable webhooks, follow part 1 of [this
116+
guide](https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
117+
to create and retrieve a webhook URL for a specific channel, then enable it in
118+
discord-irc's config as follows:
115119

116-
![discord-webhook](http://i.imgur.com/lNeJIUI.jpg)
120+
```json
121+
"webhooks": {
122+
"#discord-channel": "https://discordapp.com/api/webhooks/id/token"
123+
}
124+
```
117125

118126
### Encodings
119-
120127
If you encounter trouble with some characters being corrupted from some clients (particularly umlauted characters, such as `ä` or `ö`), try installing the optional dependencies `iconv` and `node-icu-charset-detector`.
121128
The bot will produce a warning when started if the IRC library is unable to convert between encodings.
122129

0 commit comments

Comments
 (0)