Skip to content

Commit ab1d5fd

Browse files
committed
readme: polish
1 parent eb847bd commit ab1d5fd

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ results = SurrealDB.query(db, "SELECT * FROM user WHERE age > 18")
4444
SurrealDB.close!(db)
4545
```
4646

47-
Do-block form closes in a `finally`:
47+
Do-block form auto-closes via `finally`:
4848

4949
```julia
5050
SurrealDB.connect("ws://localhost:8000"; ns="test", db="test") do db
@@ -79,10 +79,10 @@ Full reference at [danvinci.github.io/SurrealDB.jl](https://danvinci.github.io/S
7979

8080
## Cross-SDK conformance
8181

82-
Go SDK test suite ported as Julia testsets; Python interop verified via fixture round-trips.
82+
Selected Go testsets ported as Julia testsets; Python interop verified via fixture round-trips.
8383
JS + Rust planned ([roadmap](#roadmap)).
8484

85-
The comparative reference set includes [Go](https://github.com/surrealdb/surrealdb.go), [Python](https://github.com/surrealdb/surrealdb.py), [JS](https://github.com/surrealdb/surrealdb.js), [Rust](https://github.com/surrealdb/surrealdb/tree/main/crates/sdk), and [.NET](https://github.com/surrealdb/surrealdb.net).
85+
Comparative reference set: [Go](https://github.com/surrealdb/surrealdb.go), [Python](https://github.com/surrealdb/surrealdb.py), [JS](https://github.com/surrealdb/surrealdb.js), [Rust](https://github.com/surrealdb/surrealdb/tree/main/crates/sdk), [.NET](https://github.com/surrealdb/surrealdb.net).
8686

8787
## Requirements
8888

@@ -101,11 +101,14 @@ bash scripts/setup-upstream.sh
101101
bash scripts/setup-server.sh
102102
bash scripts/run-conformance.sh
103103

104+
# CI-1:1 parity locally (forces Docker like CI):
105+
SURREALDB_BACKEND=docker bash scripts/setup-server.sh
106+
104107
# Surgical iteration on a single file:
105108
julia --project=test test/sdk/cbor/test_cbor_io.jl
106109
```
107110

108-
Unit layer needs no network; integration needs `surreal start --bind 127.0.0.1:8001`; embedded needs `libsurreal`.
111+
Unit layer needs no network; integration needs `surreal start --bind 127.0.0.1:8001` (CI + conformance use `:8000`); embedded needs `libsurreal`.
109112
Layers self-skip when prerequisites are missing.
110113

111114
## Development

0 commit comments

Comments
 (0)