Skip to content

Commit e77e4e7

Browse files
committed
review: add top-level README with embedder warning
1 parent affbd73 commit e77e4e7

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

crates/wasi-threads/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# wasmtime-wasi-threads
2+
3+
Implement the `wasi-threads` [specification] in Wasmtime.
4+
5+
[specification]: https://github.com/WebAssembly/wasi-threads
6+
7+
> Note: this crate is experimental and not yet suitable for use in multi-tenant
8+
> embeddings. As specified, a trap or WASI exit in one thread must end execution
9+
> for all threads. Due to the complexity of stopping threads, however, this
10+
> implementation currently exits the process entirely. This will work for some
11+
> use cases (e.g., CLI usage) but not for embedders. This warning can be removed
12+
> once a suitable mechanism is implemented that avoids exiting the process.

0 commit comments

Comments
 (0)