Add disclaimer
Dan Abramov committed
Oct 25, 2017 at 20:47 UTC
396eb8698b63571abcac4ef158a14af9f6e84901
1 file changed
+15
packages/react-call-return/README.md
+15
@@ -6,6 +6,21 @@ This is an experimental package for multi-pass rendering in React.
6
7
**Use it at your own risk.**
8
9
+# No, Really, It Is Unstable
10
+
11
+This is **an experiment**.
12
+
13
+We will replace this with a different API in the future.
14
+It can break between patch versions of React.
15
+
16
+Don't rely on this for anything except experiments.
17
+Even in experiments, make sure to lock the versions so that an update doesn't break your app.
18
+
19
+Don't publish third party components relying on this unless you clearly mark them as experimental too.
20
+They will break.
21
+
22
+Have fun! Let us know if you find interesting use cases for it.
23
+
24
# API
25
26
See the test case in `src/__tests__/ReactCallReturn.js` for an example.