From 9422f025ee8df83a6a58e0acd00e04d1c466344b Mon Sep 17 00:00:00 2001
From: Felix Lange <fjl@twurst.com>
Date: Wed, 26 Feb 2025 15:22:10 +0100
Subject: [PATCH] cmd/workload: add README

---
 cmd/workload/README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 cmd/workload/README.md

diff --git a/cmd/workload/README.md b/cmd/workload/README.md
new file mode 100644
index 0000000000..c66396e437
--- /dev/null
+++ b/cmd/workload/README.md
@@ -0,0 +1,26 @@
+## Workload Testing Tool
+
+This tool performs RPC calls against a live node. It has tests for the Sepolia testnet and
+Mainnet.
+
+To run the tests against a Sepolia node, use:
+
+```shell
+> ./workload test --sepolia http://host:8545
+```
+
+To run a specific test, use the `--run` flag to filter the test cases. Filtering works
+similar to the `go test` command. For example, to run only tests for `eth_getBlockByHash`
+and `eth_getBlockByNumber`, use this command:
+
+```
+> ./workload test --sepolia --run History/getBlockBy http://host:8545
+```
+
+### Regenerating tests
+
+There are also commands for generating tests. To create filter tests, run:
+
+```shell
+> ./workload filtergen http://host:8545
+```