From a71e665d2e1199f3bd8ade8bf82f44990cb446d0 Mon Sep 17 00:00:00 2001 From: paolofacchinetti Date: Wed, 30 Oct 2024 20:49:55 +0100 Subject: [PATCH] docs: update erpc readme --- charts/erpc/README.md | 21 ++++----------------- charts/erpc/README.md.gotmpl | 27 +++++++-------------------- 2 files changed, 11 insertions(+), 37 deletions(-) diff --git a/charts/erpc/README.md b/charts/erpc/README.md index e8fa8ae2..9421a440 100644 --- a/charts/erpc/README.md +++ b/charts/erpc/README.md @@ -75,23 +75,10 @@ eRPC is a fault-tolerant EVM RPC proxy and re-org aware permanent caching soluti | updateStrategy | object | `{"type":"RollingUpdate"}` | Update stategy for the Statefulset | | updateStrategy.type | string | `"RollingUpdate"` | Update stategy type | -# Example +# Getting Started -Usage: dora-explorer -config config.yaml +Update the `config` field to configure the various upstreams that you want to proxy with eRPC. -Helper: -```shell -Usage of ./dora-explorer: --config string - Path to the config file, if empty string defaults will be used -``` +The `secretEnv` field can be used to securely add API keys to your configuration. -In order to name validators based on ranges the following file format can be provided YAML: -```yaml -0-500: validator_set_A -500-1000: validator_set_B -1000-1500: validator_set_C -... -``` - -More details can be found [here](https://github.com/pk910/dora). +For more information, check out the [eRPC repository](https://github.com/erpc/erpc). \ No newline at end of file diff --git a/charts/erpc/README.md.gotmpl b/charts/erpc/README.md.gotmpl index b2631b45..7434485e 100644 --- a/charts/erpc/README.md.gotmpl +++ b/charts/erpc/README.md.gotmpl @@ -14,23 +14,10 @@ {{ template "chart.valuesSection" . }} -# Example - -Usage: dora-explorer -config config.yaml - -Helper: -```shell -Usage of ./dora-explorer: --config string - Path to the config file, if empty string defaults will be used -``` - -In order to name validators based on ranges the following file format can be provided YAML: -```yaml -0-500: validator_set_A -500-1000: validator_set_B -1000-1500: validator_set_C -... -``` - -More details can be found [here](https://github.com/pk910/dora). +# Getting Started + +Update the `config` field to configure the various upstreams that you want to proxy with eRPC. + +The `secretEnv` field can be used to securely add API keys to your configuration. + +For more information, check out the [eRPC repository](https://github.com/erpc/erpc). \ No newline at end of file