docs: updated website and readme

gorhom · Aug 7, 2021 · 7f5e8d2 · 7f5e8d2
1 parent 42b98a7
commit 7f5e8d2
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # React Native Bottom Sheet
 
-[![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/)
+[![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/)
 
 A performant interactive bottom sheet with fully configurable options 🚀
 
@@ -12,7 +12,7 @@ A performant interactive bottom sheet with fully configurable options 🚀
 
 - Modal presentation view, [Bottom Sheet Modal](https://gorhom.github.io/react-native-bottom-sheet/modal).
 - Smooth interactions & snapping animations.
-- 🌟 Seamless keyboard handling. 
+- Seamless keyboard handling.
 - Support `FlatList`, `SectionList`, `ScrollView` & `View` scrolling interactions.
 - Support `React Navigation` Integration.
 - Compatible with `Reanimated` v1 & v2.
@@ -27,17 +27,15 @@ Check out [the documentation website](https://gorhom.github.io/react-native-bott
 
 ## Versioning
 
-This library been written in 2 versions of `Reanimated`, and kept both implementation in 2 separate branches:
+This library been written in 2 versions of `Reanimated`, and kept both implementation in 3 separate branches:
 
-### Version 2
+- **`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`.
 
-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).
+- **`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`.
 
-### Version 3
+- **`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`.
 
-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).
-
-All new features will be added to `Reanimated v2` version, however I will keep maintaining `Reanimated v1` version until further notice.
+> I highly recommend all `v3` users to upgrade to `v4` which provides more stability and all latest features.
 
 ## Author
 

diff --git a/website/docs/getting-started.mdx b/website/docs/getting-started.mdx
@@ -22,7 +22,7 @@ hide_table_of_contents: true
 
 # React Native Bottom Sheet
 
-[![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/)
+[![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/)
 
 A performant interactive bottom sheet with fully configurable options 🚀
 
@@ -73,12 +73,12 @@ yarn add react-native-reanimated@^1 react-native-gesture-handler
 **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).
 :::
 
-### Version 3
+### Version 4
 
 This version is written with `Reanimated v2` and **CAN NOT RUN** with `Reanimated v1`:
 
 ```bash
-yarn add @gorhom/bottom-sheet@^3
+yarn add @gorhom/bottom-sheet@^4
 ```
 
 #### Dependencies

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -47,7 +47,7 @@ module.exports = {
           sidebarPath: require.resolve('./sidebars.js'),
           routeBasePath: '/',
           editUrl:
-            'https://github.com/gorhom/react-native-bottom-sheet/edit/master/website/',
+            'https://github.com/gorhom/react-native-bottom-sheet/edit/v2/website/',
         },
         theme: {
           customCss: require.resolve('./src/css/custom.css'),