Skip to content

Commit 4b7a4e7

Browse files
committed
docs: update README and add license
1 parent cc20211 commit 4b7a4e7

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

β€ŽLICENSE

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright (c) 2024 Renan Mav
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

β€ŽREADME.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,52 @@
11
# react-native-in-app-browser
22

33
An in-app-browser (IAB) module for react-native exposing bindings for [SFSafariViewController](https://developer.apple.com/documentation/safariservices/sfsafariviewcontroller), [ASWebAuthenticationSession](https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession), [ChromeCustomTabs](https://developer.chrome.com/docs/android/custom-tabs) & more, powered by [Nitro Modules](https://nitro.margelo.com).
4+
5+
<!-- TODO: add event listeners to URL changes -->
6+
<!-- TODO: add support for incognito mode -->
7+
8+
## Features
9+
10+
- Easy-to-use API
11+
- Common cross-platform support
12+
- Platform-specific implementations (iOS and Android)
13+
14+
## Installation
15+
16+
> [!IMPORTANT]
17+
> Make sure you add [react-native-nitro-modules](https://github.com/mrousavy/nitro) as dependency.
18+
19+
```bash
20+
npx install @renanmav/react-native-in-app-browser
21+
```
22+
23+
## Usage
24+
25+
You can choose between common or platform-specific interfacing.
26+
27+
### Basic usage
28+
29+
```typescript
30+
import { InAppBrowser } from 'react-native-in-app-browser'
31+
// Open a URL in the in-app browser
32+
InAppBrowser.open('https://example.com')
33+
```
34+
35+
<!-- TODO: add platform-specific usage -->
36+
37+
## Platform Compatibility
38+
39+
| Feature | iOS | Android |
40+
| -------------------------- | --- | ------- |
41+
| InAppBrowser | βœ… | βœ… |
42+
| SFSafariViewController | βœ… | ❌ |
43+
| ASWebAuthenticationSession | βœ… | ❌ |
44+
| ChromeCustomTabs | ❌ | βœ… |
45+
46+
## Contributing
47+
48+
Contributions are welcome! Please feel free to submit a Pull Request.
49+
50+
## License
51+
52+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
Β (0)