diff --git a/packages/react-call-return/README.md b/packages/react-call-return/README.md index a38bf7f802..6cfd1265aa 100644 --- a/packages/react-call-return/README.md +++ b/packages/react-call-return/README.md @@ -10,9 +10,11 @@ This is an experimental package for multi-pass rendering in React. This is **an experiment**. -We will replace this with a different API in the future. +We **will** replace this with a different API in the future. It can break between patch versions of React. +We also know that **it has bugs**. + Don't rely on this for anything except experiments. Even in experiments, make sure to lock the versions so that an update doesn't break your app. @@ -24,3 +26,7 @@ Have fun! Let us know if you find interesting use cases for it. # API See the test case in `src/__tests__/ReactCallReturn.js` for an example. + +# What and Why + +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.