diff --git a/k8s/README.md b/k8s/README.md new file mode 100644 index 00000000..5d6a07ec --- /dev/null +++ b/k8s/README.md @@ -0,0 +1,13 @@ +# Commit boost on k8s + +Currently, only the PBS module is supported and it can be used as a +drop-in replacement to mev-boost. To quickly install it, from the +chart directory, edit the `values.yaml` configuration file to your +liking, then: + +``` +helm install commit-boost . -f values.yaml +``` + +By default the PBS service should be available on port `18550`, you +can then point your beacons to it.