Quick changelog to note we have an API update.

commit 095106dc5d5ff2903ef404a4e7f52bf430bddd5d · parent 99388b38fe · browse this tree
Eric Myhre, 2022-11-26 23:22:22 UTC

(First one that's non-additive, after all this time!)

diff --git a/README.md b/README.md
index fe7f1cb..5bf1c37 100644
--- a/README.md
+++ b/README.md
@@ -311,6 +311,14 @@ See that package for more details!
 
 
 
+Changelog
+---------
+
+Mostly the go-testmark package has been remarkly stable.  There are a series of tagged releases, but mostly they are small feature additions.  Using the latest version is always best.
+
+There's one exception: in `v0.11.0` we do have an API change.  One type gained a pointer, which was previously mostly passed by struct.  If you update code across that version, you may find you also need to add some asterisks: `DirEnt` -> `*DirEnt`.  For many usages, though, the change may not appear syntactically at all (the `:=` often covers up where it might have been necessary!).
+
+
 License
 -------