Skip to content

docs: Update README.md with implementation details #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Annhiluc merged 1 commit into from
Aug 1, 2025
Merged

docs: Update README.md with implementation details #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ test-server record --config <CONFIG_FILE> --recording-dir <RECORDING_DIR>
This runs test-server as a reverse proxy, with all interactions being saved to files under <RECORDING_DIR>.


## Running in replay mode
### Running in replay mode

To start test-server in replay mode invoke:

Expand All @@ -53,3 +53,13 @@ test-server replay --config <CONFIG_FILE> --recording-dir <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.
Loading