Skip to content

Commit 3520420

Browse files
authored
Merge pull request #8 from juspay/docs/readme
Updated readme.
2 parents b576b45 + 939d8f6 commit 3520420

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,36 @@
11
# Hyper SDK React WebView
22

3-
Custom webview for a hyper-sdk Android webview integration.
3+
Custom webview for a hyper-sdk webview integration for react-native apps.
44

5-
Installation
5+
## Installation
66

77
```sh
8-
npm install --save https://github.com/juspay/hyper-sdk-react-webview#945bd4a3716713762a323b60c153c477f117fb5a
8+
npm install hyper-sdk-react-webview
99

1010
```
1111

1212
with `yarn`
1313

1414
```sh
15-
yarn add https://github.com/juspay/hyper-sdk-react-webview#945bd4a3716713762a323b60c153c477f117fb5a
15+
yarn add hyper-sdk-react-webview
1616

1717
```
1818

19+
**NOTE** please make sure that you have also installed `react-native-webview` as a dependency. Even though it's declared as a peer dependency, react-native doesn't pickup it's native-build files unless it's specified as a direct dependency of the app.
20+
1921
## Usage
2022

23+
Add our package repository to your app's `build.gradle`
24+
```groovy
25+
// ..
26+
allprojects {
27+
repositories {
28+
// ..
29+
maven { url "https://maven.juspay.in/jp-build-packages/hyper-sdk/" }
30+
}
31+
}
32+
```
33+
2134
Add the required intent handling in `MainActivity.kt`
2235

2336
```kotlin

0 commit comments

Comments
 (0)