Skip to content

Commit e454edf

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 e454edf

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
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 wasm-wasi-component language module instead
7+
<https://unit.nginx.org/configuration/#unit-wasm-wasm-wasi-component>.
8+
9+
However there are some caveats with wasm-wasi-component.
10+
11+
* First and foremost this language module is written in rust and thus requires
12+
the rust ecosystem if building from source which can be heavy on resources.
13+
14+
* It can use significantly more memory than the original wasm module.
15+
16+
* It can't ingress or egress more than about 4GiB of data.
17+
18+
119
# C & Rust Library & Examples for Building WebAssembly Modules for NGINX Unit
220

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

0 commit comments

Comments
 (0)