From 8e69598a468d42d6815910be5d2f62f608a0b5ef Mon Sep 17 00:00:00 2001 From: rht Date: Mon, 13 Aug 2018 08:38:35 +0100 Subject: [PATCH] bridge_with_irc: Add a brief documentation. --- zulip/integrations/bridge_with_irc/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 zulip/integrations/bridge_with_irc/README.md diff --git a/zulip/integrations/bridge_with_irc/README.md b/zulip/integrations/bridge_with_irc/README.md new file mode 100644 index 0000000..67637c0 --- /dev/null +++ b/zulip/integrations/bridge_with_irc/README.md @@ -0,0 +1,20 @@ +# IRC <--> Zulip bridge + +## Usage + +``` +./irc-mirror.py --irc-server=IRC_SERVER --channel= --nick-prefix= --stream= [optional args] +``` + +`--stream` is a Zulip stream. + +Specify your Zulip API credentials and server in a ~/.zuliprc file or using the options. + +Note that "_zulip" will be automatically appended to the IRC nick provided + +## Example + +``` +./irc-mirror.py --irc-server=irc.freenode.net --channel='#python-mypy' --nick-prefix=irc_mirror --stream='test here' \ + --site="https://chat.zulip.org" --user= --api-key= +```