diff --git a/CHANGELOG.md b/CHANGELOG.md index 56c55a0..54d8a57 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,15 @@ # Changelog All notable changes to the Snapper project. +## [3.0.0-beta] - 2023-01-02 +### Behaviour changes in V3 vs V2 +- Snapper now uses `System.Text.Json` rather than `Newtonsoft.Json`. This has a few small behavioural changes. + - `GlobalSnapshotSerialiserSettings` and `SnapshotSerialiserSettings` will now be of type `JsonSerializerOptions`, which will require you to reconfigure any custom settings you have set. + - Snapshot may be formatted differently due to differences between `System.Text.Json` and `Newtonsoft.Json`. + - When using a malformed json string, previously an exception would have been thrown. In V3 the value is serialised as a string. +- Support for Arrays and Primitives. + - Previously these would be converted into a JSON object with the property name `AutoGenerated`, now they will be stored as is. + ## [2.4.1] - 2023-12-30 ### Added - Introduces the ability to update snapshots via Custom snapshot settings. This solves [Issue #104](https://github.com/theramis/Snapper/issues/104). Thanks to [@ptjhuang](https://github.com/ptjhuang) for the contribution! diff --git a/README.md b/README.md index 5d5232a..9e7dcbf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Snapper V2 +# Snapper **Bringing Jest-esque Snapshot testing to C#**