Merge branch 'lukeshu/quality2'

1 files changed, 35 insertions, 0 deletions

diff --git a/ReleaseNotes.md b/ReleaseNotes.md
new file mode 100644
index 0000000..a2365f0
--- /dev/null
+++ b/ReleaseNotes.md
@@ -0,0 +1,35 @@
+# v0.2.1 (TBD)
+
+  Theme: Code quality
+
+  This release improves code quality; getting various linters to pass,
+  adding tests (and a few bug-fixes), refactoring things to be
+  clearer, fixing some mistakes in the documentation.
+
+  User-facing changes:
+
+   - Encoder: `*EncodeMethodError` is now also used when a method
+     produces invalid JSON.
+   - Decoder: The offset in `*DecodeTypeError`s now correctly point
+     the start of the value, rather than somewhere in the middle of
+     it.
+
+# v0.2.0 (2023-01-26)
+
+  Theme: Add documentation
+
+  This release doesn't make any major changes, and is just adding
+  documentation.  I have removed a few minor things that I didn't want
+  to write documentation for.
+
+  Breaking changes:
+
+   - Drop the following shorthand functions:
+     + `func Decode(r io.RuneScanner, ptr any) error        { return NewDecoder(r).Decode(ptr) }`
+     + `func DecodeThenEOF(r io.RuneScanner, ptr any) error { return NewDecoder(r).DecodeThenEOF(ptr) }`
+     + `func Encode(w io.Writer, obj any) (err error)       { return NewEncoder(w).Encode(obj) }`
+   - Drop `const Tab = "\t"`.
+
+# v0.1.0 (2022-09-19)
+
+  Theme: Initial release