Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(examples): Make sure READMEs link to themselves #136

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion examples/component/http-client/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Go HTTP Client

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

- Implements a [`wasi:http`][wasi-http]-compliant HTTP handler
- Uses the [`httpserver` provider][httpserver-provider] to serve requests
Expand Down
3 changes: 2 additions & 1 deletion examples/component/http-password-checker/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TinyGo HTTP Password Checker

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

- Implements a [`wasi:http`][wasi-http]-compliant HTTP handler
- Uses the [`httpserver` provider][httpserver-provider] to serve requests
Expand Down
5 changes: 3 additions & 2 deletions examples/component/http-server/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Go HTTP Password Checker
# Go HTTP Server

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

- Implements a [`wasi:http`][wasi-http]-compliant HTTP handler
- Uses the [`httpserver` provider][httpserver-provider] to serve requests
Expand Down
5 changes: 3 additions & 2 deletions examples/component/invoke/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Custom WIT example

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

```wit
interface invoker {
Expand Down
3 changes: 2 additions & 1 deletion examples/component/sqldb-postgres-query/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# 🐘 SQLDB Postgres Example

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

- The [`wasmcloud:postgres` WIT contract](https://github.com/wasmCloud/wasmCloud/tree/main/wit/postgres)
- The
Expand Down
3 changes: 2 additions & 1 deletion examples/provider/http-server/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# http-server

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

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

Expand Down
3 changes: 2 additions & 1 deletion examples/provider/keyvalue-inmemory/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Keyvalue inmemory golang provider

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

## Notable files

Expand Down
Loading