diff --git a/zulip/integrations/bridge_between_zulips/README.md b/zulip/integrations/bridge_between_zulips/README.md index 31f52a9..00d4d78 100644 --- a/zulip/integrations/bridge_between_zulips/README.md +++ b/zulip/integrations/bridge_between_zulips/README.md @@ -3,18 +3,18 @@ Let `realm_1` be the first realm, `realm_2` be the second realm. Let `bot_1` be the relay bot in `realm_1`, `bot_2` be the relay bot in `realm_2`. -This bot relays each message received at a specified subject in a specified -stream from `realm_1` to a specified subject in a specified stream in `realm_2`. +This bot relays each message received at a specified topic in a specified +stream from `realm_1` to a specified topic in a specified stream in `realm_2`. Steps to create an inter-realm bridge: 1. Register a generic bot (`bot_1`) in `realm_1` 2. Enter the api info of `bot_1` into the config file (interrealm_bridge_config.py) -3. Create a stream in `realm_1` (`stream_1`) and a subject for the bridge +3. Create a stream in `realm_1` (`stream_1`) and a topic for the bridge 4. Make sure `bot_1` is subscribed to `stream_1` -5. Enter the stream and the subject into the config file. +5. Enter the stream and the topic 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. +the mirroring granularity becomes stream-wide. Instead of one topic, all +topics 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 8057cfd..f876507 100755 --- a/zulip/integrations/bridge_between_zulips/run-interrealm-bridge +++ b/zulip/integrations/bridge_between_zulips/run-interrealm-bridge @@ -60,12 +60,12 @@ def create_pipe_event(to_client: zulip.Client, from_bot: Dict[str, Any], if __name__ == "__main__": usage = """run-interrealm-bridge [--stream] - 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. + Relay each message received at a specified topic in a specified stream from + the first realm to a specified topic in a specified stream in the second realm. 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 + granularity becomes stream-wide. Instead of one topic, + all topics within the stream are mirrored as-is without translation. """ sys.path.append(os.path.join(os.path.dirname(__file__), '..'))