From f14760cc3aaec4a2c1c7a3720ecbbe3fb24e92ef Mon Sep 17 00:00:00 2001 From: Dmitry Ostrikov Date: Tue, 18 Jun 2024 20:53:43 +0700 Subject: [PATCH] feat(repeater): update README closes #196 --- packages/repeater/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/repeater/README.md b/packages/repeater/README.md index 8406da8a..4b26d981 100644 --- a/packages/repeater/README.md +++ b/packages/repeater/README.md @@ -142,8 +142,8 @@ describe('Scan', () => { ### Implementation details -Under the hood `Repeater` register `ExecuteRequestEventHandler` in bus, -which in turn uses the `RequestRunner` to proceed with request: +Under the hood `Repeater` connects to the Bright engine using web socket protocol, then listens for incoming commands from the engine. +Which in turn get executed with the `RequestRunner` to proceed with the request coming from the engine: ```ts export interface RequestRunner { @@ -152,7 +152,7 @@ export interface RequestRunner { } ``` -Package contains `RequestRunner` implementations for both HTTP and WS protocols. +Package contains `RequestRunner` implementations for HTTP protocol only. To support other protocol new class implementation of `RequestRunner` should be registered in global IoC container: ```ts