diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..942b52d --- /dev/null +++ b/readme.md @@ -0,0 +1,32 @@ +# ouch-relay + +ouchnets official relay client + +## config + +``` +{ + "networks": [ + { + "url": "irc.ouch.chat:6667", + "nick": "relay1", + "channel": "#testing", + "name": "ouchNET", + }, + { + "url": "irc.whatever.chat:6667", + "nick": "relay2", + "channel": "#test", + "name": "whateverNET", + } + ] +} +``` + +- `url` is the domain or ip of server with :PORT +- `nick` is the nickname you want the relay to use +- `channel` is the channel you want the relay to occupy +- `name` is the network Identifier for the relay +- `recvonly` set to `true` to make connection only recieve relays, not send + +you may specify as many networks as you want under the json `"netoworks"` array. All networks will then have specified channels relayed across all networks \ No newline at end of file