Skip to content

Commit 52ec602

Browse files
committed
docs: improve accuracy of multi_language_composition README
- Add source link for official WAC tool claim - Add performance disclaimer (architectural vs measured) - Clarify WIT package name mapping in migration example - Add 'where possible' qualifier to zero-copy claim
1 parent 3c3d0a1 commit 52ec602

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

examples/multi_language_composition/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ wac_remote_compose(
8080

8181
### ✅ Official WebAssembly Standard
8282

83-
`wac_compose` uses the **official WAC tool** from the Bytecode Alliance, ensuring:
83+
`wac_compose` uses the [**official WAC tool**](https://github.com/bytecodealliance/wac) from the Bytecode Alliance, ensuring:
8484
- **Standards compliance** with WebAssembly Component Model
8585
- **Proper component interconnection** through WIT interfaces
8686
- **Full composition language** support
@@ -238,10 +238,13 @@ wasmtime run bazel-bin/examples/multi_profile/development_system.wasm
238238

239239
## 📊 Performance Benefits
240240

241+
> **Note**: These characteristics are based on the WebAssembly Component Model architecture.
242+
> Actual performance depends on runtime implementation (Wasmtime, etc.) and component design.
243+
241244
WAC compositions provide:
242245

243246
- **Near-native speed** - Direct function calls between components
244-
- **Zero-copy sharing** - Efficient memory management
247+
- **Zero-copy sharing** - Efficient memory management where possible
245248
- **Lazy loading** - Components loaded on demand
246249
- **Memory isolation** - Security through sandboxing
247250

@@ -260,7 +263,9 @@ multi_language_wasm_component(
260263
# ✅ NEW: wac_compose (official standard)
261264
wac_compose(
262265
name = "new_composition",
263-
components = {":component": "pkg:component"},
266+
components = {
267+
":component": "pkg:component", # label -> WIT package name
268+
},
264269
)
265270

266271
# Or for single component, just use directly:

0 commit comments

Comments
 (0)