Skip to content

Commit

Permalink
Update websocket-relay README with brew tips
Browse files Browse the repository at this point in the history
Added brew option including how to run the example app.

Signed-off-by: Boris Mann <boris@fission.codes>
  • Loading branch information
bmann authored Oct 24, 2023
1 parent f62a024 commit f8b0fe5
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions examples/websocket-relay/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down

0 comments on commit f8b0fe5

Please sign in to comment.