Skip to content

Commit f1d8eaf

Browse files
committed
Update the README pointing to wasm-wasi-component
Point people to the new wasm-wasi-component language module, but be upfront about its current limitations. Signed-off-by: Andrew Clayton <[email protected]>
1 parent 3a751f7 commit f1d8eaf

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
**NOTE: You may wish to checkout the wasm-wasi-component language module
2+
instead.**
3+
4+
This is an SDK for the Unit wasm language module which only supports
5+
WebAssembly modules. If you wish to run wasi-http/proxy components then you
6+
should have a look at the
7+
[wasm-wasi-component](https://unit.nginx.org/configuration/#unit-wasm-wasm-wasi-component)
8+
language module instead.
9+
10+
However there are some caveats with wasm-wasi-component.
11+
12+
* First and foremost this language module is written in rust and thus requires
13+
the rust ecosystem if building from source which can be heavy on resources.
14+
15+
* It can use significantly more memory than the original wasm module.
16+
17+
* It can't ingress or egress more than about 4GiB of data.
18+
19+
120
# C & Rust Library & Examples for Building WebAssembly Modules for NGINX Unit
221

322
This provides a C library (lbunit-wasm) and Rust crates based on that library

0 commit comments

Comments
 (0)