xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

bridge_with_irc: Add a brief documentation.

Browse source
This commit is contained in:
rht 2018-08-13 08:38:35 +01:00 committed by Tim Abbott
parent 9efa0feaaf
commit 8e69598a46
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
zulip/integrations/bridge_with_irc/README.md Normal file
View file

@ -0,0 +1,20 @@
# IRC <--> Zulip bridge
## Usage
```
./irc-mirror.py --irc-server=IRC_SERVER --channel=<CHANNEL> --nick-prefix=<NICK> --stream=<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=<bot-email> --api-key=<bot-api-key>
```