diff --git a/README.md b/README.md index 44a0831..8c94457 100644 --- a/README.md +++ b/README.md @@ -140,3 +140,5 @@ Support for these IRCds was added at some point but is no longer actively mainta PyLink supports connecting to IRCds as a relay bot and forwarding users back as virtual clients, similar to Janus' Clientbot. This can be useful if the IRCd a network used isn't supported, or if you want to relay certain channels without fully linking with a network. For Relay to work properly with Clientbot, be sure to load the `relay_clientbot` plugin in conjunction with `relay`. + +Note: **Clientbot links can only be used as a leaf for Relay links - they CANNOT be used to host channels!** This means that Relay does not support having all your networks be Clientbot - in those cases you are better off using a classic relayer bot, like [RelayNext for Limnoria](https://github.com/jlu5/SupyPlugins/tree/master/RelayNext). diff --git a/docs/relay-quickstart.md b/docs/relay-quickstart.md index edd7edf..f280795 100644 --- a/docs/relay-quickstart.md +++ b/docs/relay-quickstart.md @@ -36,6 +36,7 @@ Then, to list all available channels: To create a channel on Relay: - `/msg PyLink create #channelname` +- Note: **you can only create channels on full IRCd links - this will NOT work with Clientbot.** To link to a channel already created on a different network (network names are case sensitive!): - `/msg PyLink link othernet #channelname`