refactor(web-kv): reorganize and add README.md

Signed-off-by: Roman Volosatovs <[email protected]>
bytecodealliance · Nov 7, 2024 · eb2a536 · eb2a536
1 parent 5774e2a
commit eb2a536
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 32 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/examples/web/README.md b/examples/web/README.md
@@ -0,0 +1,23 @@
+# `wasi-keyvalue` in the Web
+
+This example shows a Web app using `wasi:keyvalue` implementation provided by the server via WebTransport using wRPC.
+
+The server acts as both a direct implementor of `wasi:keyvalue` and a "proxy", which can delegate `wasi:keyvalue` calls issued by the Web client to other `wasi:keyvalue` implementations via various transports supported by wRPC.
+
+## Runing
+
+With `cargo`:
+
+```
+cargo run -p wasi-keyvalue-web
+```
+
+## `wasi-keyvalue` plugins
+
+To invoke other wRPC `wasi:keyvalue` plugins in "proxy" mode, for example TCP, try:
+
+```
+cargo run -p wasi-keyvalue-tcp-server
+```
+
+And select `wRPC/TCP` as the protocol in the UI
diff --git a/examples/web/rust/Cargo.toml b/examples/web/rust/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "web-rust-keyvalue"
+name = "wasi-keyvalue-web"
 version = "0.1.0"
 
 authors.workspace = true

diff --git a/examples/web/rust/src/main.rs b/examples/web/rust/src/main.rs
@@ -677,7 +677,7 @@ async fn main() -> anyhow::Result<()> {
         .context("failed to query WebTransport socket address")?;
     let port = ep_addr.port();
 
-    let index = get(Html(include_str!("../index.html")));
+    let index = get(Html(include_str!("../../ui/index.html")));
     let http = axum::serve(
         lis,
         Router::new()

diff --git a/examples/web/rust/index.html → examples/web/ui/index.html b/examples/web/rust/index.html → examples/web/ui/index.html