From 07a145c6f88e0c0f87fa582a044d167e5b12aca8 Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Fri, 17 Sep 2021 02:49:37 +0100 Subject: [PATCH] docs(readme): another minor formatting fix wording tweak --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 77b72b1..9f68dcd 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

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

@@ -40,8 +40,6 @@ import "github.com/jimeh/go-golden" ## Usage -Typical usage should look something like this: - ```go func TestExampleMyStruct(t *testing.T) { got, err := json.Marshal(&MyStruct{Foo: "Bar"}) @@ -60,7 +58,7 @@ The above example will read/write to: - `testdata/TestExampleMyStruct.golden` -To update the golden file (have `golden.Update()` return true), simply set the +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 `true` when running tests.