From 9b4b5311cfec3fb1b692b52603a572d5c70fa6fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marjorie=20Maill=C3=A9?= <129197567+MarjorieMaillee@users.noreply.github.com> Date: Thu, 20 Jun 2024 11:22:40 -0400 Subject: [PATCH] Update README.md --- README.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a6360e1..963b7c0 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ The objective of the library is to ease the discomfort of scrolling by implementing keyboard management for user input. While another solution offered plug-and-play functionality, we opted against it because it lacked the flexibility to address issues as they arise. We believe our approach will empower you to resolve any challenges your app may encounter. -We re-implemented two flows from existing apps to showcase our library. +We recreated two flows from existing apps to showcase our library. | Twitch's sign up | Shop's check out | | ------------- | ------------- | @@ -12,31 +12,35 @@ We re-implemented two flows from existing apps to showcase our library. ## Installation +### react-native-magic-scroll + +```sh +yarn install @appandflow/react-native-magic-scroll +``` + +```sh +npm i @appandflow/react-native-magic-scroll +``` + ### Dependencies To use our library, you will need to install these two dependencies into your project. **1) React Native Reanimated** -`npx expo install react-native-reanimated` +```sh +npx expo install react-native-reanimated +``` Learn more about this dependency [here](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started). **2) SafeAreaContext** -`npx expo install react-native-safe-area-context` - -Learn more about this dependency [here](https://docs.expo.dev/versions/latest/sdk/safe-area-context/). - -### react-native-magic-scroll - ```sh -yarn install @appandflow/react-native-magic-scroll +npx expo install react-native-safe-area-context ``` -```sh -npm i @appandflow/react-native-magic-scroll -``` +Learn more about this dependency [here](https://docs.expo.dev/versions/latest/sdk/safe-area-context/). ### Android @@ -56,7 +60,7 @@ On Android, make sure to set `android:windowSoftInputMode` in your `AndroidManif ## Basic Usage -Wrap your form/screen within our ScrollView. Utilizing context requires it to be one level higher for enhanced control over your inputs, or alternatively, you can employ the Higher Order Component (HOC) for this purpose. +Wrap your form/screen within our ScrollView. ```tsx import { MagicScroll } from '@appandflow/react-native-magic-scroll';