Skip to content

Commit e727b9a

Browse files
committed
Readme updated
1 parent a8f7ef5 commit e727b9a

1 file changed

Lines changed: 10 additions & 17 deletions

File tree

README.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,21 @@
11
# react-native-keyevent
22

33
Config plugin to auto configure react-native-keyevent on prebuild
4-
5-
# API documentation
6-
7-
- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/react-native-keyevent.md)
8-
- [Documentation for the latest stable release](https://docs.expo.dev/versions/latest/sdk/react-native-keyevent/)
9-
10-
# Installation in managed Expo projects
11-
12-
For [managed](https://docs.expo.dev/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation). If you follow the link and there is no documentation available then this library is not yet usable within managed projects — it is likely to be included in an upcoming Expo SDK release.
13-
14-
# Installation in bare React Native projects
15-
16-
For bare React Native projects, you must ensure that you have [installed and configured the `expo` package](https://docs.expo.dev/bare/installing-expo-modules/) before continuing.
17-
184
### Add the package to your npm dependencies
195

206
```
21-
npm install react-native-keyevent
7+
yarn add react-native-keyevent react-native-keyevent-expo-config-plugin
228
```
239

24-
25-
10+
In your `app.json` or equivalent, add the following;
11+
```js
12+
{
13+
expo: {
14+
/* ... */
15+
plugins: ['./plugins/withReactNativeKeyEvent'],
16+
},
17+
}
18+
```
2619

2720
# Contributing
2821

0 commit comments

Comments
 (0)