Skip to content

Commit 3a979df

Browse files
RayKay91RayKay91
authored andcommitted
chore: update read me
1 parent 3cbf66b commit 3a979df

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ npm install react-native-easter-egg
1717

1818
Import the `<EasterEgg />` component and wrap your component with it. It will allow it to move along the vertical and horizontal planes. It accepts a number of props which will allow you to customise it to your needs.
1919

20+
Since this package relies on react-native-gesture-handler and react-native-reanimated please see the installation instructions for those if you're getting errors. The gesture handler for example requires that the app be wrapped in a `<GestureHandlerRootView />`.
21+
22+
2023
| Prop | Default | Description |
2124
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2225
| onCodeInputSuccess | N/A | A function that will be executed when the user inputs match the secret code. **REQUIRED** |
@@ -30,7 +33,6 @@ Import the `<EasterEgg />` component and wrap your component with it. It will al
3033
| resetTimer | 20000 | The time in ms that it will take to reset the user inputs. After the timeout the user can enter the gestures again. Or they can unmount and remount the component by navigating away or something. |
3134
| secretCode | [ Directions.UP, Directions.UP, Directions.DOWN, Directions.DOWN, Directions.LEFT, Directions.RIGHT, Directions.LEFT, Directions.RIGHT, ] | The secret code that the user must match with their inputs. Defaults to the Konami code. You can import the `Directions` enum and create your own custom array of directions for a more personalised secret code. |
3235

33-
Since this package relies on react-native-gesture-handler and react-native-reanimated please see the installation instructions for those if you're getting errors. The gesture handler for example requires that the app be wrapped in a `<GestureHandlerRootView />`.
3436

3537
```tsx
3638
import { EasterEgg } from 'react-native-easter-egg';

0 commit comments

Comments
 (0)