Add a link to RCR explanation
Dan Abramov committed
Nov 3, 2017 at 00:47 UTC
6ad203630bd314e769c52620f35b247622a63824
1 file changed
+7
-1
packages/react-call-return/README.md
+7
-1
@@ -10,9 +10,11 @@ This is an experimental package for multi-pass rendering in React.
10
11
This is **an experiment**.
12
13
-We will replace this with a different API in the future.
13
+We **will** replace this with a different API in the future.
14
It can break between patch versions of React.
15
16
+We also know that **it has bugs**.
17
+
18
Don't rely on this for anything except experiments.
19
Even in experiments, make sure to lock the versions so that an update doesn't break your app.
20
@@ -24,3 +26,7 @@ Have fun! Let us know if you find interesting use cases for it.
26
# API
27
28
See the test case in `src/__tests__/ReactCallReturn.js` for an example.
29
+
30
+# What and Why
31
+
32
+The API is not very intuitive right now, but [this is a good overview](https://cdb.reacttraining.com/react-call-return-what-and-why-7e7761f81843) of why it might be useful in some cases. We are very open to better API ideas for this concept.