Skip to content

Commit b73d0cf

Browse files
committed
Update readme
1 parent d6673c7 commit b73d0cf

1 file changed

Lines changed: 17 additions & 21 deletions

File tree

README.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,37 +8,33 @@ This runner manages instances of [OpenWorkers Runtime](https://github.com/openwo
88

99
### Build
1010

11-
The runner supports multiple JavaScript runtime backends via feature flags:
11+
The runner supports multiple JavaScript runtime backends via feature flags.
1212

13-
```bash
14-
# Deno runtime (default)
15-
cargo build --release
16-
17-
# QuickJS runtime
18-
cargo build --release --no-default-features --features quickjs
19-
20-
# V8 runtime (standalone, without Deno)
21-
cargo build --release --no-default-features --features v8
13+
**V8 is the recommended runtime** for production use.
2214

23-
# Boa runtime (pure Rust)
24-
cargo build --release --no-default-features --features boa
25-
26-
# JavaScriptCore runtime (macOS/iOS)
27-
cargo build --release --no-default-features --features jsc
15+
```bash
16+
# V8 runtime (recommended)
17+
cargo build --release --features v8
18+
19+
# Alternative runtimes (experimental)
20+
cargo build --release --features quickjs # QuickJS - lightweight
21+
cargo build --release --features boa # Boa - pure Rust
22+
cargo build --release --features jsc # JavaScriptCore (macOS/iOS)
23+
cargo build --release --features deno # Deno - legacy
2824
```
2925

3026
Available features:
3127

32-
- `deno` (default) - Full Deno runtime with Web APIs
28+
- `v8` - **Recommended** - Standalone V8 engine with full Web API support
3329
- `quickjs` - Lightweight QuickJS engine
34-
- `v8` - Standalone V8 engine
35-
- `boa` - Pure Rust JS engine
30+
- `boa` - Pure Rust JS engine (experimental)
3631
- `jsc` - JavaScriptCore (Apple platforms)
32+
- `deno` - Full Deno runtime (legacy, not actively maintained)
3733

38-
### Snapshot the runtime
34+
### Snapshot the runtime (V8 only)
3935

4036
```bash
41-
cargo run --bin snapshot
37+
cargo run --features v8 --bin snapshot
4238
```
4339

4440
### Prepare the database
@@ -92,7 +88,7 @@ WORKER_DOMAINS=workers.rocks,workers.dev.localhost
9288
```bash
9389
export RUST_LOG=openworkers_runtime=debug,openworkers_runner=debug # Optional
9490

95-
cargo run --features v8|deno|quickjs|boa|jsc
91+
cargo run --features v8
9692
```
9793

9894
### Install sqlx-cli (optional - only for development)

0 commit comments

Comments
 (0)