From 5d1588cc4d8db56ec451948c289caa50ec1e8152 Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Fri, 17 Sep 2021 02:46:50 +0100 Subject: [PATCH] docs(readme): fix and improve formatting --- README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d78ae36..77b72b1 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@

- Yet another Go package for working with `*.golden` test files, with a focus - on simplicity through it's default behavior. + Yet another Go package for working with *.golden test files, + with a focus on simplicity through it's default behavior.

@@ -32,14 +32,9 @@ alt="GitHub issues">

-Golden file names are based on the name of the test function and any subtest -names by calling t.Name(). File names are sanitized to ensure they're compatible -with Linux, macOS and Windows systems regardless of what crazy characters might -be in a subtest's name. - ## Import -``` +```go import "github.com/jimeh/go-golden" ``` @@ -63,7 +58,7 @@ func TestExampleMyStruct(t *testing.T) { The above example will read/write to: - testdata/TestExampleMyStruct.golden +- `testdata/TestExampleMyStruct.golden` To update the golden file (have `golden.Update()` return true), simply set the `GOLDEN_UPDATE` environment variable to one of `1`, `y`, `t`, `yes`, `on`, or