Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@ali-bahjati
ali-bahjati committed Dec 13, 2023
1 parent 77eb722 commit 24ef579
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ includes a health check mechanism to detect and address high latency issues.

# How to use Beacon?

To run Beacon, install `nats-server` and then run it using this command:
To run Beacon, you need to have Go v1.20.10 or older and `nats-server` installed.

Run a NATS server using this command:

```shell
nats-server --jetstream
Expand All @@ -35,4 +37,5 @@ For optimal performance, co-locate Beacon with the NATS server to minimize overa
instances to increase availability and reduce latency, but be mindful that this will scale network traffic. Utilize the
health check probe to monitor VAA latency and restart instances if they become unhealthy.

# It works with Go v1.20.12 and older
# Wormhole P2P configuration
You can find the Wormhole peer-to-peer network configuration [here](https://docs.wormhole.com/wormhole/explore-wormhole/spy).

0 comments on commit 24ef579

Please sign in to comment.