Skip to content

Commit

Permalink
docs: update erpc readme
Browse files Browse the repository at this point in the history
  • Loading branch information
paolofacchinetti committed Oct 30, 2024
1 parent e8fdf8c commit a71e665
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 37 deletions.
21 changes: 4 additions & 17 deletions charts/erpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
27 changes: 7 additions & 20 deletions charts/erpc/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit a71e665

Please sign in to comment.