Skip to content

Commit c8f8a7e

Browse files
committed
docs: updated readme file
1 parent 4bbfff7 commit c8f8a7e

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

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

3-
[![npm](https://img.shields.io/npm/v/@gorhom/bottom-sheet?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) [![Reanimated v2](https://img.shields.io/badge/Reanimated-v2-%23001a72?style=flat-square)](https://docs.swmansion.com/react-native-reanimated/) [![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/)
4-
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/)
54

65
A performant interactive bottom sheet with fully configurable options 🚀
76

@@ -25,6 +24,20 @@ A performant interactive bottom sheet with fully configurable options 🚀
2524

2625
Check out [the documentation website](https://gorhom.github.io/react-native-bottom-sheet).
2726

27+
## Versioning
28+
29+
This library been written in 2 versions of `Reanimated`, and kept both implementation in 2 separate branches:
30+
31+
### Version 2
32+
33+
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+
35+
### Version 3
36+
37+
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).
38+
39+
All new features will be added to `Reanimated v2` version, however I will keep maintaining `Reanimated v1` version until further notice.
40+
2841
## Author
2942

3043
- [Mo Gorhom](https://gorhom.dev/)

0 commit comments

Comments
 (0)