Skip to content

Commit 6e1d1a1

Browse files
RayKay91RayKay91
authored andcommitted
chore: release 0.1.7
1 parent 7a6bb67 commit 6e1d1a1

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@
22

33
A fun little easter egg to include in your app. A component that accepts gestures and will match them to a secret code for your users to input.
44

5-
65
<img src='./sample-img.gif' height='30%' width='30%' />
76

8-
9-
107
## Installation
118

129
```sh
1310
npm install react-native-easter-egg
1411
```
1512

13+
**Note**
14+
15+
Since this package relies on react-native-gesture-handler and react-native-reanimated (they are peer dependencies) 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 />`, and reanimated requires you to update the babel config by adding a plugin.
16+
1617
## Usage
1718

1819
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.
@@ -30,8 +31,6 @@ Import the `<EasterEgg />` component and wrap your component with it. It will al
3031
| 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. |
3132
| 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. |
3233

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 />`.
34-
3534
```tsx
3635
import { EasterEgg } from 'react-native-easter-egg';
3736

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-native-easter-egg",
3-
"version": "0.1.6",
3+
"version": "0.1.8",
44
"description": "An easter egg that you can you use in your react native app.",
55
"main": "lib/commonjs/index",
66
"module": "lib/module/index",

0 commit comments

Comments
 (0)