Skip to content

Commit

Permalink
docs: updated readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
gorhom committed Nov 27, 2020
1 parent 9b1e341 commit 185f7a6
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +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)
- [Version v2 with Reanimated v1](#version-v2)
- [Version v3 with Reanimated v2](#version-v3)
3. [Usage](#usage)
- 🌟 [Bottom Sheet Modal](./docs/modal.md)
- [Custom Handle](./docs/custom-handle.md)
Expand Down Expand Up @@ -49,11 +49,9 @@ A performant interactive bottom sheet with fully configurable options 🚀

## Installation

### Version v1
### Version v2 with Reanimated 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`
[Link to version 2 branch](https://github.com/gorhom/react-native-bottom-sheet/)

```sh
yarn add @gorhom/bottom-sheet
Expand All @@ -63,16 +61,16 @@ 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 ( Alpha )
### Version v3 ( Alpha ) with Reanimated v2

[Link to version 2 branch](https://github.com/gorhom/react-native-bottom-sheet/tree/feature/rewrite-in-reanimated-v2)
[Link to version 3 branch](https://github.com/gorhom/react-native-bottom-sheet/tree/feature/v3)

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
yarn add @gorhom/bottom-sheet@3.0.0-alpha.0
# or
npm install @gorhom/bottom-sheet@2.0.0-alpha.0
npm install @gorhom/bottom-sheet@3.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.
Expand Down

0 comments on commit 185f7a6

Please sign in to comment.