Commit d7d9a7e4 authored by Kevin Today's avatar Kevin Today Committed by GitHub

docs: Clarify package parameters in README (#88)

parent 6531a7af
......@@ -21,6 +21,21 @@ Quickstart
```bash
docker image ls
```
1. Run the package:
```bash
kurtosis run --enclave eth2 github.com/kurtosis-tech/eth2-package
```
To remove the enclave running the Ethereum network, run `kurtosis enclave rm -f eth2`.
You can customize the package's behaviour by passing in a configuration JSON or YAML (see the "Configuration" section below). For example:
```bash
kurtosis run --enclave eth2 github.com/kurtosis-tech/eth2-package '{"global_client_log_level": "info"}'
```
For extra convenience, you can store the parameters in a file:
1. Create a file in your home directory `eth2-package-params.json` with the following contents:
```yaml
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment