Add breaking API warnings

memowe · Nov 22, 2018 · 4140e09 · 4140e09
1 parent e08f906
commit 4140e09
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/Changes b/Changes
@@ -1,4 +1,5 @@
 0.6     ????-??-??
+    - BREAKING CHANGE: Serialization API has changed and uses YAML instead of Storable
     - Use a transformation store build on startup time instead of serializing subroutines
 
 0.51    2018-08-24

diff --git a/README.md b/README.md
@@ -13,6 +13,12 @@
 
 A minimal event sourcing framework.
 
+---
+
+**ATTENTION**: as of version 0.6 there is an API change regarding serialization which breaks existing applications that use serialization as well as their existing event stores.
+
+---
+
 ## Example
 
 ```perl

diff --git a/lib/EventStore/Tiny.pm b/lib/EventStore/Tiny.pm
@@ -183,6 +183,8 @@ sub is_correct_snapshot {
 
 EventStore::Tiny - A minimal event sourcing framework.
 
+B<ATTENTION>: as of version 0.6 there is an API change regarding serialization which breaks existing applications that use serialization as well as their existing event stores.
+
 =begin html
 
 <p>