Skip to content

Commit a80916f

Browse files
authored
Update README.md
1 parent 587fdc6 commit a80916f

File tree

1 file changed

+38
-6
lines changed

1 file changed

+38
-6
lines changed

README.md

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,6 @@ yarn add @reason-react-native/inappbrowser
4141

4242
## Usage
4343

44-
### Examples
45-
4644
```reason
4745
open Js.Promise;
4846
@@ -71,15 +69,49 @@ openAuthIos("https://example.com/auth", "myschema://auth", iosOptions())
7169

7270
### Types
7371

74-
#### `ReactNativeInAppBrowser.t`
72+
#### `authResult`
73+
#### `browserResult`
74+
#### `iosOptions`
75+
#### `androidOptions`
7576

76-
...
7777

7878
### Methods
7979

80-
#### `ReactNativeInAppBrowser.method`
80+
#### `ReactNativeInAppBrowser.openBrowserIos`
81+
82+
```reason
83+
(string, iosOptions) => Js.Promise.t(browserResult)
84+
```
85+
86+
#### `ReactNativeInAppBrowser.openBrowserAndroid`
87+
88+
```reason
89+
(string, androidOptions) => Js.Promise.t(browserResult)
90+
```
91+
92+
#### `ReactNativeInAppBrowser.close`
93+
94+
```reason
95+
unit => unit
96+
```
8197

82-
...
98+
#### `ReactNativeInAppBrowser.openAuthIos`
99+
100+
```reason
101+
(string, iosOptions) => Js.Promise.t(authResult)
102+
```
103+
104+
#### `ReactNativeInAppBrowser.openAuthAndroid`
105+
106+
```reason
107+
(string, androidOptions) => Js.Promise.t(authResult)
108+
```
109+
110+
#### `ReactNativeInAppBrowser.closeAuth`
111+
112+
```reason
113+
unit => unit
114+
```
83115

84116
---
85117

0 commit comments

Comments
 (0)