From ceda54b50c3eb09e3757806096e2b10a3026c72d Mon Sep 17 00:00:00 2001 From: rht Date: Fri, 13 Mar 2020 23:05:01 -0400 Subject: [PATCH] bridge_between_zulips: Add explanation of --stream to README.md. --- zulip/integrations/bridge_between_zulips/README.md | 5 +++++ .../bridge_between_zulips/run-interrealm-bridge | 6 ++++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/zulip/integrations/bridge_between_zulips/README.md b/zulip/integrations/bridge_between_zulips/README.md index 6b344d8..31f52a9 100644 --- a/zulip/integrations/bridge_between_zulips/README.md +++ b/zulip/integrations/bridge_between_zulips/README.md @@ -13,3 +13,8 @@ Steps to create an inter-realm bridge: 4. Make sure `bot_1` is subscribed to `stream_1` 5. Enter the stream and the subject into the config file. 6. Do step 1-5 but for `bot_2` and with all occurrences of `_1` replaced with `_2` +7. Run the script `run-interrealm-bridge` + +If the `--stream` flag is added (i.e. `run-interrealm-bridge --stream`), then +the mirroring granularity becomes stream-wide. Instead of one subject, all +subjects within the stream are mirrored as-is without translation. diff --git a/zulip/integrations/bridge_between_zulips/run-interrealm-bridge b/zulip/integrations/bridge_between_zulips/run-interrealm-bridge index 367e47d..8057cfd 100755 --- a/zulip/integrations/bridge_between_zulips/run-interrealm-bridge +++ b/zulip/integrations/bridge_between_zulips/run-interrealm-bridge @@ -63,8 +63,10 @@ if __name__ == "__main__": Relay each message received at a specified subject in a specified stream from the first realm to a specified subject in a specified stream in the second realm. - If the --stream flag is added, then the tunnel granularity becomes - stream-wide. All subjects are mirrored as-is without translation. + If the --stream flag is added, then the mirroring + granularity becomes stream-wide. Instead of one subject, + all subjects within the stream are mirrored as-is without + translation. """ sys.path.append(os.path.join(os.path.dirname(__file__), '..'))