summaryrefslogtreecommitdiff
path: root/ReleaseNotes.md
diff options
context:
space:
mode:
authorLuke Shumaker <lukeshu@lukeshu.com>2023-01-27 13:12:35 -0700
committerLuke Shumaker <lukeshu@lukeshu.com>2023-01-30 21:58:29 -0700
commitcbf8ec9ae3212e9642385c034fe0b0846af6dfd0 (patch)
tree7f4a64fa5365ffd3b285f921c5f905754b3883b3 /ReleaseNotes.md
parentd473f861a5c3a3112c83518eafbcda50e274b182 (diff)
BREAKING CHANGE: reencode: Separate config from state
Diffstat (limited to 'ReleaseNotes.md')
-rw-r--r--ReleaseNotes.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/ReleaseNotes.md b/ReleaseNotes.md
index e4327db..874aeec 100644
--- a/ReleaseNotes.md
+++ b/ReleaseNotes.md
@@ -1,3 +1,25 @@
+# v0.3.0 (TBD)
+
+ Theme: Breaking changes
+
+ This release makes a breaking change to the way *ReEncoder works.
+ This change both better fits what's convenient to use, and enables
+ making future performance improvements.
+
+ Breaking changes:
+
+ - ReEncoder: Instead of instantiating a `*ReEncoder` with
+
+ ```go
+ reenc := &lowmemjson.ReEncoder{Out: w, settings}
+ ```
+
+ it is now instantiated with
+
+ ```go
+ reenc := lowmemjson.NewReEncoder(w, lowmemjson.ReEncoderConfig{settings})
+ ```
+
# v0.2.1 (2023-01-30)
Theme: Code quality