From f8b0fe543e5b88379fbd86b126c6fad269e97792 Mon Sep 17 00:00:00 2001 From: Boris Mann Date: Tue, 24 Oct 2023 10:39:46 -0700 Subject: [PATCH] Update websocket-relay README with brew tips Added brew option including how to run the example app. Signed-off-by: Boris Mann --- examples/websocket-relay/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/examples/websocket-relay/README.md b/examples/websocket-relay/README.md index a89cafaa..a6ac7bd5 100644 --- a/examples/websocket-relay/README.md +++ b/examples/websocket-relay/README.md @@ -60,10 +60,12 @@ if they've been previously run. ## Tips & Common Issues -- On macOS, for example, a simple homebrew install would install everything you +On macOS, for example, a simple homebrew install would install everything you need: `brew install rust npm ipfs` -- Running `homestar` via `cargo run` requires a minimum Rust version of +We have packaged homestar binaries via brew, so `brew install fission-codes/fission/homestar` will install everything you need, including `ipfs`. You will still need npm to run this example. From this folder, you can run the example via `homestar start --config ./config/settings.toml --db homestar.db`. + +Running `homestar` via `cargo run` requires a minimum Rust version of `1.70.0`. If you've got an older install of rust, update it with `rustup update`.