Skip to content

Commit 397fa2d

Browse files
janb84stringintech
andauthored
Revise README architecture and usage instructions (#4)
Co-authored-by: stringintech <stringintech@gmail.com>
1 parent e9ab1f7 commit 397fa2d

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ The framework ensures that all language bindings (Go, Python, Rust, etc.) behave
1414
## Architecture
1515

1616
```
17-
┌─────────────┐ ┌──────────────────┐
18-
│ Test Runner │────────▶│ Handler Binary
19-
│ (Go CLI) │ stdin │ (Go/Rust/etc) │
20-
│ │◀────────│ │
21-
└─────────────┘ stdout └──────────────────┘
17+
┌─────────────┐ ┌──────────────────
18+
│ Test Runner │────────▶│ Handler Binary**
19+
│ (Go CLI) │ stdin │ (Go/Rust/etc)
20+
│ │◀────────│
21+
└─────────────┘ stdout └──────────────────
2222
│ │
2323
│ │
2424
▼ ▼
@@ -35,19 +35,33 @@ The framework ensures that all language bindings (Go, Python, Rust, etc.) behave
3535
3. [**Test Cases**](./testdata): JSON files defining requests and expected responses
3636
4. [**Mock Handler**](./cmd/mock-handler/main.go): Validates the runner by echoing expected responses from test cases
3737

38-
**Handler binaries** are not hosted in this repository. They must be implemented separately following the [**Handler Specification**](./docs/handler-spec.md) and should:
38+
** **Handler binaries** are not hosted in this repository. They must be implemented separately following the [**Handler Specification**](./docs/handler-spec.md) and should:
3939
- Implement the JSON protocol for communication with the test runner
4040
- Call the binding API to execute operations
4141
- Pin to a specific version/tag of this test repository
4242

4343
## Getting Started
4444

45-
Build and test against the mock handler:
45+
### Testing Your Binding (Custom Handler)
46+
47+
Test your handler implementation using the test runner:
48+
49+
```bash
50+
# Build the test runner
51+
make runner
52+
53+
# Run the test runner against your handler binary
54+
./build/runner --handler <path-to-your-handler>
55+
```
56+
57+
### Testing the Runner
58+
59+
Build and test the runner using the mock handler:
4660

4761
```bash
4862
# Build both runner and mock handler
4963
make build
5064

51-
# Run tests against the mock handler
65+
# Run the test runner against the mock handler
5266
make test
5367
```

0 commit comments

Comments
 (0)