docs(api): document deprecation of whitelist in favor of allowlist

thibaudcolas · Nov 21, 2020 · 682a914 · 682a914
1 parent 4d48cba
commit 682a914
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -98,6 +98,10 @@ blockTextRules?: $ReadOnlyArray<{
 }>,
 ```
 
+### Deprecated
+
+`filterEditorState` (and `shouldKeepEntityByAttribute` described further below) used to support a `whitelist` config option. It has been renamed to `allowlist`, and will be removed altogether in a future release.
+
 ### Types
 
 If your project uses [Flow](https://flow.org/), type inference should just work. If you don't use Flow, it won't get in your way either.