Skip to content

Commit

Permalink
docs(README): Emphasize non-production use of project
Browse files Browse the repository at this point in the history
  • Loading branch information
aidenybai committed Dec 28, 2024
1 parent be3b8dc commit 5069840
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
> ⚠️⚠️⚠️ **this project may break production apps and cause unexpected behavior** ⚠️⚠️⚠️
>
> this project uses react internals, which can change at any time. it is not recommended to depend on internals unless you really, _really_ have to. by proceeding, you acknowledge the risk of breaking your own code or apps that use your code.
>
> we use this project interally in [react-scan](https://github.com/aidenybai/react-scan), which is deployed in development and production. we use this package "safely" by ensuring that it is only used in development, and when it is deployed to production, it is removed from the bundle or properly error guarded. if you're planning to use this project outside of tinkering, please read over react-scan's source code to see how we safeguard usage.
# <img src="https://github.com/aidenybai/bippy/blob/main/.github/assets/bippy.png?raw=true" width="60" align="center" /> bippy

Expand All @@ -20,12 +22,6 @@ bippy allows you to access fiber information from outside of react and provides

<sub><sup>\*disclaimer: "attempt" used loosely, i highly recommend not relying on this in production</sub></sup>

## how to use this project safely

1. **do not rely on this in production**
2. **do not rely on this in production**
3. **do not rely on this in production**

## how it works

bippy allows you to **access** and **use** fibers from outside of react.
Expand Down

0 comments on commit 5069840

Please sign in to comment.