BREAKING CHANGE: added migration guide

immerjs · Feb 2, 2019 · b79bb97 · b79bb97
1 parent 9c498e1
commit b79bb97
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -711,6 +711,12 @@ Most important observation:
 -   Generating patches doesn't significantly slow immer down
 -   The ES5 fallback implementation is roughly twice as slow as the proxy implementation, in some cases worse.
 
+## Migration
+
+**Immer 1.\* -> 2.0**
+
+Make sure you don't return any promises as state, because `produce` will actually invoke the promise and wait until it settles.
+
 ## FAQ
 
 _(for those who skimmed the above instead of actually reading)_