From 3ec80cdd62cf611e18c51e94524a1c7428ae9ead Mon Sep 17 00:00:00 2001
From: Matty Evans <mattevansnz@gmail.com>
Date: Fri, 10 Jan 2025 13:27:44 +1000
Subject: [PATCH 1/2] docs: Add configuration details to README

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/README.md b/README.md
index 13295c7..f01561f 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,43 @@ contributoor config   # View/edit configuration
 contributoor update   # Update the service to the latest version
 ```
 
+## Configuration
+
+The [contributoor-installer](https://github.com/ethpandaops/contributoor-installer) will generate a `config.yaml` file for you.
+
+```yaml
+# The address of your beacon node's HTTP API.
+beaconNodeAddress: http://127.0.0.1:64692
+
+# The address of your metrics server (defaults to :9090).
+metricsAddress: ":9090"
+
+# The log level (debug, info, warn, error).
+logLevel: info
+
+# The network name (NETWORK_NAME_MAINNET, NETWORK_NAME_SEPOLIA, NETWORK_NAME_HOLESKY).
+networkName: NETWORK_NAME_MAINNET
+
+# The output server configuration (credentials are base64 encoded and required if a pandaops server is used).
+outputServer:
+    address: https://xatu.primary.production.platform.ethpandaops.io
+    credentials: YWRtaW46YWRtaW4=
+
+# The contributoor version to use.
+version: 0.0.8
+
+# The directory where contributoor stores its configuration and data.
+contributoorDirectory: /Users/username/.contributoor
+
+# The method to run contributoor (RUN_METHOD_DOCKER, RUN_METHOD_BINARY, RUN_METHOD_SYSTEMD).
+```
+
+If you encounter configuration issues, you can:
+
+1. Compare your config with the example above
+2. Remove the config file and re-run `contributoor install` to generate a fresh one
+3. Check the debug logs for detailed error messages
+
 ## Development
 
 ### Running Locally

From f070300063fb281ad3f335239c1462774dc127cf Mon Sep 17 00:00:00 2001
From: Matty Evans <mattevansnz@gmail.com>
Date: Fri, 10 Jan 2025 13:28:37 +1000
Subject: [PATCH 2/2] style: Update README.md formatting

---
 README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/README.md b/README.md
index f01561f..70fbc73 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,7 @@ version: 0.0.8
 contributoorDirectory: /Users/username/.contributoor
 
 # The method to run contributoor (RUN_METHOD_DOCKER, RUN_METHOD_BINARY, RUN_METHOD_SYSTEMD).
+runMethod: RUN_METHOD_DOCKER
 ```
 
 If you encounter configuration issues, you can: