Skip to content

Commit dd8c5b5

Browse files
committed
Add README note clarifying upgrade choices between 5.6.0 and 6.0.0-rc.2
1 parent 5f1a04a commit dd8c5b5

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ Modern secure storage for React Native, powered by Nitro Modules. Version 6 ship
1515
> [!IMPORTANT]
1616
> This README tracks the in-progress v6 work on `master`. For the stable legacy release, switch to the `v5.x` branch.
1717
18+
> [!NOTE]
19+
> **Choosing between 5.6.0 and 6.0.0-rc.2**
20+
>
21+
- **Need bridge stability?** `5.6.0` is the last pre-Nitro release with the latest biometric fixes, docs, and Android namespace cleanups. It’s drop-in for any `5.5.x` app already running on React Native’s Fabric architecture, but you keep the legacy JS bridge overhead—Paper is no longer supported.
22+
> - **Ready for Nitro speed?** `6.0.0-rc.2` swaps in the Nitro hybrid core, auto-enforces Class 3/StrongBox biometrics, and ships the refreshed sample app plus richer metadata. Upgrade when you can adopt the Nitro toolchain (RN 0.76+, Node 18+, `react-native-nitro-modules`).
23+
> - **Staying back on 5.5.x?** You remain on the legacy (Paper) architecture and miss the Android 13 prompt fixes, the manual credential fallback restoration, and the new docs—migrate to `5.6.0` at minimum before planning the Nitro jump.
24+
1825
## Table of contents
1926

2027
- [🚀 Highlights](#-highlights)

0 commit comments

Comments
 (0)