From f458aef45e0da0768c79c066b2aa92baf651decf Mon Sep 17 00:00:00 2001
From: maclane <maclane@nucypher.com>
Date: Thu, 10 Sep 2026 10:57:56 -0500
Subject: [PATCH] Document Threshold maintenance and test Go Electrum

---
 .github/workflows/test.yml | 22 ++++++++++++++++++++++
 README.md                  | 20 ++++++++++++++++++++
 2 files changed, 42 insertions(+)
 create mode 100644 .github/workflows/test.yml

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 0000000..cd31c20
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,22 @@
+name: Go
+on:
+  push:
+    branches: [master]
+  pull_request:
+permissions:
+  contents: read
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go: ["1.24.1", "1.26.0"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go }}
+      - run: go test -race ./...
+      - run: go vet ./...
diff --git a/README.md b/README.md
index ab6f029..68362d3 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
+# Threshold Go Electrum
+
+Maintained fork of [keep-network/go-electrum](https://github.com/keep-network/go-electrum),
+which extends checksum0/go-electrum with WebSocket support and fixes used by keep-core.
+The initial Threshold fork preserves upstream commit
+`6038cb594daa66c69ea0482fa849b165b115c97b` without runtime changes.
+
+The module retains `github.com/checksum0/go-electrum` as its declared path so existing
+Go imports and type identities remain compatible. Consumers select this fork in
+`go.mod`:
+
+```go
+replace github.com/checksum0/go-electrum => github.com/threshold-network/go-electrum v0.0.0-20240206170935-6038cb594daa
+```
+
+Run `go test ./...` and `go vet ./...` when contributing. The upstream MIT license
+is retained. New fixes belong in this Threshold repository.
+
+---
+
 # go-electrum [![GoDoc](https://godoc.org/github.com/checksum0/go-electrum?status.svg)](https://godoc.org/github.com/checksum0/go-electrum)
 A pure Go [Electrum](https://electrum.org/) bitcoin library supporting the latest [ElectrumX](https://github.com/kyuupichan/electrumx) protocol versions.  
 This makes it easy to write cryptocurrencies based services in a trustless fashion using Go without having to run a full node.