From fea90a977626e6afc9447c6b68d2f9926c1f239d Mon Sep 17 00:00:00 2001 From: Mo Gorhom Date: Thu, 24 Sep 2020 19:21:50 +0200 Subject: [PATCH] docs: added reference to version 2 branch --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 9062e2a26..1ec7aefb2 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ A performant interactive bottom sheet with fully configurable options 🚀 1. [Features](#features) 2. [Installation](#installation) + - [Version 1](#version-v1) + - [Version 2](#version-v2) 3. [Usage](#usage) - [Custom Handle](./docs/custom-handle.md) - [React Navigation Integration](./docs/react-navigation.md) @@ -45,6 +47,12 @@ A performant interactive bottom sheet with fully configurable options 🚀 ## Installation +### Version v1 + +[Link to version 1 branch](/~https://github.com/gorhom/react-native-bottom-sheet/tree/feature/rewrite-in-reanimated-v2) + +This version is written with `Reanimated v1` + ```sh yarn add @gorhom/bottom-sheet # or @@ -53,6 +61,22 @@ npm install @gorhom/bottom-sheet > ⚠️ You need to install [react-native-reanimated](/~https://github.com/software-mansion/react-native-reanimated) & [react-native-gesture-handler](/~https://github.com/software-mansion/react-native-gesture-handler) and follow their installation instructions. + +### Version v2 + +[Link to version 2 branch](/~https://github.com/gorhom/react-native-bottom-sheet/tree/feature/rewrite-in-reanimated-v2) + +this version is written with `Reanimated v2`, although this version is still in alpha phase, yet it provides all version 1 functionalities with the huge performance boost, thanks to `Reanimated v2` ❤️ + + +```sh +yarn add @gorhom/bottom-sheet@2.0.0-alpha.0 +# or +npm install @gorhom/bottom-sheet@2.0.0-alpha.0 +``` + +> ⚠️ You need to install [react-native-reanimated v2](https://docs.swmansion.com/react-native-reanimated/docs/next/installation) & [react-native-gesture-handler](/~https://github.com/software-mansion/react-native-gesture-handler) and follow their installation instructions. + ## Usage ```tsx