Skip to content

Commit fde48a5

Browse files
immanuwellericgregory
authored andcommitted
docs(readme): fix stale template and example docs
Signed-off-by: immanuwell <pchpr.00@list.ru>
1 parent 4b9c512 commit fde48a5

4 files changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,12 @@ wash new https://github.com/wasmCloud/typescript.git --name my-project --subfold
3535
| [http-hello-world-hono](./templates/http-hello-world-hono/) | Minimal HTTP server component using Hono |
3636
| [http-hello-world-fetch](./templates/http-hello-world-fetch/) | Minimal HTTP server component using the `fetch()` API |
3737
| [http-client](./templates/http-client/) | Component that makes outgoing HTTP requests |
38+
| [http-api-with-distributed-workloads](./templates/http-api-with-distributed-workloads/) | HTTP API + worker template demonstrating distributed workloads via `wasmcloud:messaging` |
3839
| [http-handler-hono](./templates/http-handler-hono/) | HTTP handler component powered by Hono |
3940
| [http-blobstore-handler-hono](./templates/http-blobstore-handler-hono/) | HTTP handler component powered by Hono, backed by `wasi:blobstore` |
41+
| [http-filesystem-handler-hono](./templates/http-filesystem-handler-hono/) | HTTP handler component powered by Hono, backed by `wasi:filesystem` |
4042
| [http-kv-handler-hono](./templates/http-kv-handler-hono/) | HTTP handler component powered by Hono, backed by `wasi:keyvalue` |
43+
| [http-logging-handler-hono](./templates/http-logging-handler-hono/) | HTTP handler component powered by Hono, backed by `wasi:logging` |
4144
| [service-tcp-echo](./templates/service-tcp-echo/) | Service + component template demonstrating `wasi:sockets` TCP |
4245

4346
See the [templates README](./templates/README.md) for more details.

examples/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,11 @@ Example components for building wasmCloud applications with TypeScript.
1111
| [http-server-with-hono](./components/http-server-with-hono/) | HTTP server component with routing powered by [Hono](https://hono.dev) |
1212
| [http-streaming](./components/http-streaming/) | HTTP component that streams a response using `wasi:io` primitives |
1313
| [http-axios](./components/http-axios/) | Component that makes outgoing HTTP requests using [Axios](https://axios-http.com) |
14+
| [http-stdio](./components/http-stdio/) | HTTP component that demonstrates writing to stdout and stderr via `wasi:cli` |
1415
| [bundled-esbuild](./components/bundled-esbuild/) | TypeScript component bundled with [esbuild](https://esbuild.github.io) |
1516
| [bundled-rsbuild](./components/bundled-rsbuild/) | TypeScript component bundled with [Rsbuild](https://rsbuild.dev) |
17+
| [wasi-config-from-k8s-env](./components/wasi-config-from-k8s-env/) | HTTP component that reads configuration via `wasi:config/store` |
18+
| [webgpu-tensorflow](./components/webgpu-tensorflow/) | Service + component example for GPU-accelerated TensorFlow.js style transfer |
1619

1720
## Example Structure
1821

templates/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,12 @@ Project templates for building wasmCloud components with TypeScript.
99
| [http-hello-world-hono](./http-hello-world-hono/) | Minimal HTTP server component using Hono |
1010
| [http-hello-world-fetch](./http-hello-world-fetch/) | Minimal HTTP server component using the `fetch()` API |
1111
| [http-client](./http-client/) | Component that makes outgoing HTTP requests |
12+
| [http-api-with-distributed-workloads](./http-api-with-distributed-workloads/) | HTTP API + worker template demonstrating distributed workloads via `wasmcloud:messaging` |
1213
| [http-handler-hono](./http-handler-hono/) | HTTP handler component powered by Hono |
1314
| [http-blobstore-handler-hono](./http-blobstore-handler-hono/) | HTTP handler component powered by Hono, backed by `wasi:blobstore`|
15+
| [http-filesystem-handler-hono](./http-filesystem-handler-hono/) | HTTP handler component powered by Hono, backed by `wasi:filesystem` |
1416
| [http-kv-handler-hono](./http-kv-handler-hono/) | HTTP handler component powered by Hono, backed by `wasi:keyvalue` |
17+
| [http-logging-handler-hono](./http-logging-handler-hono/) | HTTP handler component powered by Hono, backed by `wasi:logging` |
1518
| [service-tcp-echo](./service-tcp-echo/) | Service + component template demonstrating `wasi:sockets` TCP |
1619

1720
## Template Structure

templates/http-hello-world-fetch/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ A minimal WebAssembly component built with [TypeScript][ts] that responds to HTT
2020
Use `wash new` to scaffold a new wasmCloud component project:
2121

2222
```shell
23-
wash new https://github.com/wasmCloud/typescript.git --name http-hello-world --subfolder templates/http-hello-world
23+
wash new https://github.com/wasmCloud/typescript.git --name http-hello-world-fetch --subfolder templates/http-hello-world-fetch
2424
```
2525

2626
```shell
27-
cd http-hello-world
27+
cd http-hello-world-fetch
2828
```
2929

3030
To build this project and run in a hot-reloading development loop, run `npm run dev` from this directory:

0 commit comments

Comments
 (0)