Skip to content

Commit

Permalink
revise doc (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
chong-he authored Oct 9, 2023
1 parent ae57ee1 commit f164b02
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Eleel is written in Rust and makes use of components from [Lighthouse][].
## Build from source

```
cargo install --release --locked
cargo install --locked --path .
```

A binary will be installed to `~/.cargo/bin/eleel`.
Expand Down Expand Up @@ -99,7 +99,7 @@ For full CLI options see [`./docs/cli-reference.md`](./docs/cli-reference.md), o
- `POST /canonical`: JSON-RPC endpoint for the controlling consensus client. Requires a JWT
token authenticated by the JWT secret provided to the
`--controller-jwt-secret` flag.
- `GET /health`: health endpoint returning a 200 OK whenever Eleel is running.
- `curl -X GET "http://localhost:8552/health" -v`: health endpoint returning a 200 OK whenever Eleel is running.

## Logging

Expand Down Expand Up @@ -128,6 +128,8 @@ lighthouse bn \
--suggested-fee-recipient 0xffffffffffffffffffffffffffffffffffffffff
```

> Note: If both consensus clients are using the same port (for example, Lighthouse uses p2p port 9000 by default), the second consensus client will require an additional flag `--port`.
Some other consensus clients provide similar flags.

## License
Expand Down

0 comments on commit f164b02

Please sign in to comment.