Skip to content

Commit

Permalink
Add disclaimer
Browse files Browse the repository at this point in the history
  • Loading branch information
gaearon authored Oct 25, 2017
1 parent 2c0a8fb commit 396eb86
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions packages/react-call-return/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@ This is an experimental package for multi-pass rendering in React.

**Use it at your own risk.**

# No, Really, It Is Unstable

This is **an experiment**.

We will replace this with a different API in the future.
It can break between patch versions of React.

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.

Don't publish third party components relying on this unless you clearly mark them as experimental too.
They will break.

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.

0 comments on commit 396eb86

Please sign in to comment.