Skip to content

Commit

Permalink
docs: added reference to version 2 branch
Browse files Browse the repository at this point in the history
  • Loading branch information
gorhom committed Sep 24, 2020
1 parent 2e9a177 commit fea90a9
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit fea90a9

Please sign in to comment.