Skip to content

Commit 1b32113

Browse files
fix(examples): Make sure READMEs link to themselves
This makes it so it is easy for the copied docs to link back to the repo. There are probably other things we can do in the future to make this better, but should be a good start Signed-off-by: Taylor Thomas <[email protected]>
1 parent 964c086 commit 1b32113

File tree

7 files changed

+16
-9
lines changed

7 files changed

+16
-9
lines changed

examples/component/http-client/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Go HTTP Client
22

3-
This repository contains a WebAssembly Component compiled using [TinyGo][tinygo], which:
3+
[This example](https://github.com/wasmCloud/go/tree/main/examples/component/http-client) is a
4+
WebAssembly Component compiled using [TinyGo][tinygo], which:
45

56
- Implements a [`wasi:http`][wasi-http]-compliant HTTP handler
67
- Uses the [`httpserver` provider][httpserver-provider] to serve requests

examples/component/http-password-checker/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# TinyGo HTTP Password Checker
22

3-
This repository contains a WebAssembly Component written in [TinyGo][tinygo], which:
3+
[This example](https://github.com/wasmCloud/go/tree/main/examples/component/http-password-checker)
4+
is a WebAssembly Component written in [TinyGo][tinygo], which:
45

56
- Implements a [`wasi:http`][wasi-http]-compliant HTTP handler
67
- Uses the [`httpserver` provider][httpserver-provider] to serve requests

examples/component/http-server/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# Go HTTP Password Checker
1+
# Go HTTP Server
22

3-
This repository contains a WebAssembly Component compiled using [TinyGo][tinygo], which:
3+
[This example](https://github.com/wasmCloud/go/tree/main/examples/component/http-server) is a
4+
WebAssembly Component compiled using [TinyGo][tinygo], which:
45

56
- Implements a [`wasi:http`][wasi-http]-compliant HTTP handler
67
- Uses the [`httpserver` provider][httpserver-provider] to serve requests

examples/component/invoke/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Custom WIT example
22

3-
This example shows how to combine the wasmCloud Component SDK with your custom interfaces. You can
4-
find the custom interface in `wit/world.wit`. It should look something like this:
3+
[This example](https://github.com/wasmCloud/go/tree/main/examples/component/invoke) shows how to
4+
combine the wasmCloud Component SDK with your custom interfaces. You can find the custom interface
5+
in `wit/world.wit`. It should look something like this:
56

67
```wit
78
interface invoker {

examples/component/sqldb-postgres-query/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# 🐘 SQLDB Postgres Example
22

3-
This folder contains a WebAssembly component that makes use of:
3+
[This example](https://github.com/wasmCloud/go/tree/main/examples/component/sqldb-postgres-query) is
4+
a WebAssembly component that makes use of:
45

56
- The [`wasmcloud:postgres` WIT contract](https://github.com/wasmCloud/wasmCloud/tree/main/wit/postgres)
67
- The

examples/provider/http-server/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# http-server
22

3-
This example demonstrates how to forward requests to components exporting `wasi:http/incoming-handler`.
3+
[This example](https://github.com/wasmCloud/go/tree/main/examples/provider/http-server) demonstrates
4+
how to forward requests to components exporting `wasi:http/incoming-handler`.
45

56
It starts a http server listening on port 8080 containing 2 routes:
67

examples/provider/keyvalue-inmemory/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Keyvalue inmemory golang provider
22

3-
This provider implements `wrpc:keyvalue/[email protected]`.
3+
[This provider example](https://github.com/wasmCloud/go/tree/main/examples/provider/keyvalue-inmemory)
4+
is implements `wrpc:keyvalue/[email protected]`.
45

56
## Notable files
67

0 commit comments

Comments
 (0)