usage in readme

.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Test
+
+on:
+  pull_request:
+    branches: '*'
+  push:
+    branches:
+      - main
+      - ci-test
+
+jobs:
+  test:
+    name: Run unit tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version-file: 'go.mod'
+          check-latest: true
+      - name: Set up Gitea access token
+        env:
+          TOKEN: ${{ secrets.CICD_REPO_TOKEN }}
+        run: |
+          git config --global url."https://$TOKEN:@git.vdb.to/".insteadOf https://git.vdb.to/
+      - name: Build tools
+        run: make dumpdiff.plugeth dumpdiff.geth
+      - name: Run diff comparison
+        run: ./scripts/compare-diffs.sh
+          

README.md

@@ -3,3 +3,11 @@
 Tooling to directly verify and benchmark the results of go-ethereum state diffs.
 
 Specifically, compares `plugeth-statediff`- and `go-ethereum/statediff`-built diffs.
+
+## Usage
+
+```
+make dumpdiff.plugeth dumpdiff.geth
+
+./scripts/compare-diffs.sh
+```

scripts/compare-diffs.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-set -ex
+set -e
 
 PLUGIN_OUTPUT=$(mktemp -d -t plugin_)
 GETH_OUTPUT=$(mktemp -d -t geth_)
@@ -11,4 +11,5 @@ GETH_OUTPUT=$(mktemp -d -t geth_)
 for file in $(ls $PLUGIN_OUTPUT)
 do
   diff "$PLUGIN_OUTPUT/$file" "$GETH_OUTPUT/$file"
+  echo Files match: "$PLUGIN_OUTPUT/$file" "$GETH_OUTPUT/$file"
 done