Add a link to RCR explanation

This commit is contained in:
Dan Abramov 2017-11-03 00:47:54 +00:00 committed by GitHub
parent 73bb99626f
commit 6ad203630b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 1 deletions

View File

@ -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.