commit 9fca03383ce6e070d681b20b187f1c74b50adb38
parent 9b5d7e11f74f2997732c0c8ef773dc0159f27a96
author: rj1 <[email protected]>
date:   Sat, 28 May 2022 00:32:31 -0500

added readme

Diffstat:
A
README.md
 | 
18
++++++++++++++++++

1 file changed, 18 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# znc oneway relay
+
+znc module to create oneway relays for channels you'd like to mirror 
+
+## limitation:
+you can't specify a source network to relay from, only a channel name. if you're
+in two channels w/ the same name on separate networks, it will relay both.
+
+this is a limitation in znc. if you know a way to get around this, create an
+issue or pull request on github.
+
+## commands
+| command | description            | example                            
+| ---     | ---                    | ---                                
+| help    | show this help message | help                               
+| add     | add a relay            | add #znc privatenetwork #znc-relay 
+| del     | delete a relay         | del 0                              
+| list    | list all relays        | list