diff --git a/CHANGELOG.md b/CHANGELOG.md index 6073234..9056ecb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.1.1 + +- Updating class documentation + ## 0.1.0 -* Initial release. +- Initial release. diff --git a/lib/json_delta.dart b/lib/json_delta.dart index 5db2721..54a49d4 100644 --- a/lib/json_delta.dart +++ b/lib/json_delta.dart @@ -2,7 +2,13 @@ library json_delta; import "package:collection/collection.dart"; +/// Abstract class for `JsonDelta` mixin to work with. This class should be +/// implemented by any class that wants to use the `JsonDelta` mixin. abstract class JsonSerializable { + + /// Converts the object to a JSON object + /// This method should implement your object's serialization logic + /// that will be used to save the object's state and compare it later. Map toJson(); } diff --git a/pubspec.yaml b/pubspec.yaml index b676b49..1f9b31b 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: json_delta description: Dart extension for serializing and an object to a JSON delta. -version: 0.1.0 +version: 0.1.1 homepage: https://github.com/oddbit/dart-json-delta environment: