Skip to content

Commit

Permalink
docs: updated website & readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gorhom committed Dec 22, 2020
1 parent 08219cf commit 216432a
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 8 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# React Native Bottom Sheet

[![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) [![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/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/)

A performant interactive bottom sheet with fully configurable options 🚀

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

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

## Versioning

This library been written in 2 versions of `Reanimated`, and kept both implementation in 2 separate branches:

### Version 2

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).

### Version 3

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.

## Author

- [Mo Gorhom](https://gorhom.dev/)
Expand Down
8 changes: 4 additions & 4 deletions website/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ hide_table_of_contents: true

# React Native Bottom Sheet

[![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) [![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/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/)

A performant interactive bottom sheet with fully configurable options 🚀

Expand Down Expand Up @@ -57,7 +57,7 @@ This library provides two versions that are align with `Reanimated v1 & v2`
This version is written with `Reanimated v1` & compatible with `Reanimated v2`:

```bash
yarn add @gorhom/bottom-sheet
yarn add @gorhom/bottom-sheet@2.0.0
```

#### Dependencies
Expand All @@ -79,15 +79,15 @@ yarn add react-native-reanimated react-native-gesture-handler
This version is written with `Reanimated v2` and **CAN NOT RUN** with `Reanimated v1`:

```bash
yarn add @gorhom/bottom-sheet@3.0.0-alpha.0
yarn add @gorhom/bottom-sheet
```

#### Dependencies

This library needs these dependencies to be installed in your project before you can use it:

```bash
yarn add react-native-reanimated@alpha react-native-gesture-handler
yarn add react-native-reanimated@2.0.0-rc.1 react-native-gesture-handler
```

:::info
Expand Down
2 changes: 0 additions & 2 deletions website/docs/modal/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,3 @@ The implementation of this feature was inspired by Apple Maps sheet modals ❤
## Installation

This feature been shipped with `@gorhom/bottom-sheet` package and it requires no extra dependency.

> Currently available on v1 & v2 (alpha), however it was planned to be added to v3. [Feel free to contribute ❤️](https://github.com/gorhom/react-native-bottom-sheet/issues/76)

0 comments on commit 216432a

Please sign in to comment.