Skip to content

Commit d1be3b4

Browse files
committed
brige_with_irc: Add a brief documentation.
1 parent 488416f commit d1be3b4

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# IRC <--> Zulip bridge
2+
3+
## Usage
4+
5+
```
6+
./irc-mirror.py --irc-server=IRC_SERVER --channel=<CHANNEL> --nick-prefix=<NICK> --stream=<STREAM> [optional args]
7+
```
8+
9+
`--stream` is a Zulip stream.
10+
11+
Specify your Zulip API credentials and server in a ~/.zuliprc file or using the options.
12+
13+
Note that "_zulip" will be automatically appended to the IRC nick provided
14+
15+
## Example
16+
17+
```
18+
./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>
19+
```

0 commit comments

Comments
 (0)