add a readme

Author: millotp

README.md

@@ -0,0 +1,35 @@
+# gocksnap [![GitHub release](https://img.shields.io/badge/version-v0.1-green.svg?style=flat)](https://github.com/millotp/gocksnap/releases)
+
+Jest-like snapshot built on top of [gock](https://github.com/h2non/gock).
+
+It allows you to record HTTP request for a test, select the response for each one and replay the snapshot in the test.
+
+## Example
+
+```go
+func TestWithHTTP(t *testing.T) {
+    defer gock.off()
+
+    snapshot := gocksnap.MatchSnapshot(t, "name of the scenario")
+
+    // put you code here that calls HTTP endpoint
+    // ...
+    
+    // call finish to save the snapshot and assert that the test is complete
+    snapshot.Finish(t)
+}
+```
+
+## Preview
+
+When running the test for the first time, the library will open a web server to select the response for each request:
+
+<img width="1040" height="871" alt="Screenshot 2025-08-20 at 19 10 35" src="https://github.com/user-attachments/assets/779bcb86-5943-4bfb-9e25-f0218e5595b3" />
+
+Select the desired `status` and `response body` that should be returned for this request, and click `Save Snapshot`.
+
+## Updating a snapshot
+
+To edit an existing snapshot, you can run your test with the environment variable `UPDATE_GOCKSNAP=true`, a new button will appear to reuse the response from the existing snapshot:
+
+<img width="1039" height="334" alt="Screenshot 2025-08-20 at 19 13 16" src="https://github.com/user-attachments/assets/5105b67f-3509-4ac3-817a-423d34498e1a" />

gocksnap.go

@@ -128,7 +128,7 @@ func (g *Snapshot) promptCall(req *http.Request, existingCall *Call) *Call {
 }
 
 // MatchSnapshot creates a new snapshot for the current test.
-// If the snapshot file is not found, or if the environment variable UPDATE_TESTS is set to "true", it will spawn a web server to allow the user to interactively select responses for the recorded requests.
+// If the snapshot file is not found, or if the environment variable UPDATE_GOCKSNAP is set to "true", it will spawn a web server to allow the user to interactively select responses for the recorded requests.
 // If the snapshot file is found, it will load the existing calls and register them with gock.
 // After all the calls are finished, the user should call the Finish method to save the snapshot / assert that all calls were mocked correctly.
 func MatchSnapshot(t *testing.T, snapshotName string) *Snapshot {
@@ -138,7 +138,7 @@ func MatchSnapshot(t *testing.T, snapshotName string) *Snapshot {
 		Calls:      []Call{},
 		testName:   t.Name(),
 		name:       snapshotName,
-		updateMode: os.Getenv("UPDATE_TESTS") == "true",
+		updateMode: os.Getenv("UPDATE_GOCKSNAP") == "true",
 		sseConns:   make(map[chan string]struct{}),
 	}
 

index.html

@@ -157,7 +157,7 @@ <h1 id="title">Gocksnap Console</h1>
             }
 
             function showForm(data) {
-                document.getElementById('title').textContent = "Snapshot for " + data.name;
+                document.getElementById('title').textContent = "Snapshot for: " + data.name;
                 let html = `
                 <div>
                     <label>Incoming request:</label>