Skip to content

Commit

Permalink
fix: Websocket Relay README typos & formatting (#353)
Browse files Browse the repository at this point in the history
# Description

The README for the WebSocket Relay has some minor typographical errors

- [Before
🏚️](https://github.com/ipvm-wg/homestar/tree/main/examples/websocket-relay)
- [After
🏠](https://github.com/ipvm-wg/homestar/blob/fix-example-typo/examples/websocket-relay/README.md)

## Link to issue

N/A

## Type of change

- [x] Bug fix (non-breaking change that fixes an issue)

## Test plan (required)

Look at it

## Screenshots/Screencaps

Please add previews of any UI Changes.
  • Loading branch information
expede committed Oct 5, 2023
1 parent 78fc493 commit 571d99d
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions examples/websocket-relay/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,30 @@ An example application that connects to a `homestar-runtime` node
over a websocket connection in order to run static Wasm-based, image
processing workflows that chain inputs and outputs using
[inlined promises][pipelines].

This application demonstrates:

* websocket notifications of [Ucan Invocation receipts][spec-receipts] sent
* websocket notifications of [UCAN Invocation Receipts][spec-receipts] sent
between a web client and a `homestar` runner
* instantaneous replay of previously run, cached executions
* fetching content (the original static image) over [IPFS][ipfs]
through a local blockstore
* the [WIT][wit] + [Ipld][ipld] interpreter for
* the [WIT][wit] + [IPLD][ipld] interpreter for
[Wasm(time)][wasmtime] embedded execution within a `homestar` runner.

## Install

To get started, please install:
### Nix

If you're using our [Nix file](../../flake.nix), you get these installs for free.

* [rust][install-rust], unless you're running `homestar` [as a binary][rust-binary]
* [node & npm][install-npm]
* [kubo/ipfs installed][install-ipfs]
### Manual

To get started, please install:

If you're using our [nix file](../../flake.nix)], you get these installs for
free.
* [Rust][install-rust], unless you're running `homestar` [as a binary][rust-binary]
* [Node & NPM][install-npm]
* [Kubo IPFS][install-ipfs]

## Usage

Expand Down Expand Up @@ -64,7 +67,7 @@ need: `brew install rust npm ipfs`
`1.70.0`. If you've got an older install of rust, update it with
`rustup update`.

You do not have to start-up `kubo`/`ipfs` on your own. The example will do this
You do not have to start-up Kubo (IPFS) on your own. The example will do this
for you, and use `examples/websocket-relay/tmp/.ipfs` as a local blockstore.
Feel free to discard it when you don't need it.

Expand Down

0 comments on commit 571d99d

Please sign in to comment.