From 9c3fc5e429c31c18607ddba201f7efbf50a95a4b Mon Sep 17 00:00:00 2001 From: Annie Luc Date: Fri, 1 Aug 2025 10:31:53 -0700 Subject: [PATCH] Update README.md with implementation details --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4fb41a1..a3590a8 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ test-server record --config --recording-dir This runs test-server as a reverse proxy, with all interactions being saved to files under . -## Running in replay mode +### Running in replay mode To start test-server in replay mode invoke: @@ -53,3 +53,13 @@ test-server replay --config --recording-dir This will have test-server listen on the local endpoints and respond to requests with the recorded responses. Requests that were not recorded will be answered with an internal server error. + + +## Implementation + +This library is implemented as a Go Binary that can be run as a standalone executable. + + +### SDKs + +This repository also defines a TypeScript SDK which wraps around the Go Binary and provides a usability layer for TS projects by introducing convenience methods to start and stop the test-server.