Skip to content

Commit 7f5e8d2

Browse files
committed
docs: updated website and readme
1 parent 42b98a7 commit 7f5e8d2

File tree

3 files changed

+11
-13
lines changed

3 files changed

+11
-13
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# React Native Bottom Sheet
22

3-
[![Reanimated v1 version](https://img.shields.io/github/package-json/v/gorhom/react-native-bottom-sheet/master?label=Reanimated%20v1&style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![Reanimated v2 version](https://img.shields.io/github/package-json/v/gorhom/react-native-bottom-sheet/v3?label=Reanimated%20v2&style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![npm](https://img.shields.io/npm/l/@gorhom/bottom-sheet?style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![npm](https://img.shields.io/badge/types-included-blue?style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![runs with expo](https://img.shields.io/badge/Runs%20with%20Expo-4630EB.svg?style=flat-square&logo=EXPO&labelColor=f3f3f3&logoColor=000)](https://expo.io/)
3+
[![Reanimated v2 version](https://img.shields.io/github/package-json/v/gorhom/react-native-bottom-sheet/master?label=Reanimated%20v2&style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![Reanimated v1 version](https://img.shields.io/github/package-json/v/gorhom/react-native-bottom-sheet/v2?label=Reanimated%20v1&style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![npm](https://img.shields.io/npm/l/@gorhom/bottom-sheet?style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![npm](https://img.shields.io/badge/types-included-blue?style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![runs with expo](https://img.shields.io/badge/Runs%20with%20Expo-4630EB.svg?style=flat-square&logo=EXPO&labelColor=f3f3f3&logoColor=000)](https://expo.io/)
44

55
A performant interactive bottom sheet with fully configurable options 🚀
66

@@ -12,7 +12,7 @@ A performant interactive bottom sheet with fully configurable options 🚀
1212

1313
- Modal presentation view, [Bottom Sheet Modal](https://gorhom.github.io/react-native-bottom-sheet/modal).
1414
- Smooth interactions & snapping animations.
15-
- 🌟 Seamless keyboard handling.
15+
- Seamless keyboard handling.
1616
- Support `FlatList`, `SectionList`, `ScrollView` & `View` scrolling interactions.
1717
- Support `React Navigation` Integration.
1818
- Compatible with `Reanimated` v1 & v2.
@@ -27,17 +27,15 @@ Check out [the documentation website](https://gorhom.github.io/react-native-bott
2727

2828
## Versioning
2929

30-
This library been written in 2 versions of `Reanimated`, and kept both implementation in 2 separate branches:
30+
This library been written in 2 versions of `Reanimated`, and kept both implementation in 3 separate branches:
3131

32-
### Version 2
32+
- **`v2`** | [branch](https://github.com/gorhom/react-native-bottom-sheet/tree/v2) | [changelog](https://github.com/gorhom/react-native-bottom-sheet/blob/v2/CHANGELOG.md) : written with `Reanimated v1` & compatible with `Reanimated v2`.
3333

34-
This version is written with `Reanimated v1` & compatible with `Reanimated v2`, this version is located at [`master` branch](https://github.com/gorhom/react-native-bottom-sheet/tree/master) and its [changelog here](https://github.com/gorhom/react-native-bottom-sheet/blob/master/CHANGELOG.md).
34+
- **`v3`** | [branch](https://github.com/gorhom/react-native-bottom-sheet/tree/v3) | [changelog](https://github.com/gorhom/react-native-bottom-sheet/blob/v3/CHANGELOG.md) : written with `Reanimated v2`, soon to be deprecated in-favour of `v4`.
3535

36-
### Version 3
36+
- **`v4 (alpha)`** | [branch](https://github.com/gorhom/react-native-bottom-sheet/tree/master) | [changelog](https://github.com/gorhom/react-native-bottom-sheet/blob/master/CHANGELOG.md) : written with `Reanimated v2`.
3737

38-
This version is written with `Reanimated v2` and **CAN NOT RUN** with `Reanimated v1`, this version is located at [`v3` branch](https://github.com/gorhom/react-native-bottom-sheet/tree/v3) and its [changelog here](https://github.com/gorhom/react-native-bottom-sheet/blob/v3/CHANGELOG.md).
39-
40-
All new features will be added to `Reanimated v2` version, however I will keep maintaining `Reanimated v1` version until further notice.
38+
> I highly recommend all `v3` users to upgrade to `v4` which provides more stability and all latest features.
4139
4240
## Author
4341

website/docs/getting-started.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ hide_table_of_contents: true
2222

2323
# React Native Bottom Sheet
2424

25-
[![Reanimated v1 version](https://img.shields.io/github/package-json/v/gorhom/react-native-bottom-sheet/master?label=Reanimated%20v1&style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![Reanimated v2 version](https://img.shields.io/github/package-json/v/gorhom/react-native-bottom-sheet/v3?label=Reanimated%20v2&style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![npm](https://img.shields.io/npm/l/@gorhom/bottom-sheet?style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![npm](https://img.shields.io/badge/types-included-blue?style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![runs with expo](https://img.shields.io/badge/Runs%20with%20Expo-4630EB.svg?style=flat-square&logo=EXPO&labelColor=f3f3f3&logoColor=000)](https://expo.io/)
25+
[![Reanimated v1 version](https://img.shields.io/github/package-json/v/gorhom/react-native-bottom-sheet/v2?label=Reanimated%20v1&style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![Reanimated v2 version](https://img.shields.io/github/package-json/v/gorhom/react-native-bottom-sheet/master?label=Reanimated%20v2&style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![npm](https://img.shields.io/npm/l/@gorhom/bottom-sheet?style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![npm](https://img.shields.io/badge/types-included-blue?style=flat-square)](https://www.npmjs.com/package/@gorhom/bottom-sheet) [![runs with expo](https://img.shields.io/badge/Runs%20with%20Expo-4630EB.svg?style=flat-square&logo=EXPO&labelColor=f3f3f3&logoColor=000)](https://expo.io/)
2626

2727
A performant interactive bottom sheet with fully configurable options 🚀
2828

@@ -73,12 +73,12 @@ yarn add react-native-reanimated@^1 react-native-gesture-handler
7373
**React Native Reanimated v1** needs extra steps to finalize its installation, please follow their [installation instructions](https://docs.swmansion.com/react-native-reanimated/docs/1.x.x/getting_started).
7474
:::
7575

76-
### Version 3
76+
### Version 4
7777

7878
This version is written with `Reanimated v2` and **CAN NOT RUN** with `Reanimated v1`:
7979

8080
```bash
81-
yarn add @gorhom/bottom-sheet@^3
81+
yarn add @gorhom/bottom-sheet@^4
8282
```
8383

8484
#### Dependencies

website/docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ module.exports = {
4747
sidebarPath: require.resolve('./sidebars.js'),
4848
routeBasePath: '/',
4949
editUrl:
50-
'https://github.com/gorhom/react-native-bottom-sheet/edit/master/website/',
50+
'https://github.com/gorhom/react-native-bottom-sheet/edit/v2/website/',
5151
},
5252
theme: {
5353
customCss: require.resolve('./src/css/custom.css'),

0 commit comments

Comments
 (0)