Skip to content

Commit 00fbf00

Browse files
authored
Update README.md
1 parent c358dc1 commit 00fbf00

File tree

1 file changed

+0
-29
lines changed

1 file changed

+0
-29
lines changed

README.md

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
11
# React Native WebView - a Modern, Cross-Platform WebView for React Native
22

3-
**React Native WebView** is a modern, well-supported, and cross-platform WebView for React Native. It is intended to be a replacement for the built-in WebView (which will be [removed from core](https://github.com/react-native-community/discussions-and-proposals/pull/3)).
4-
53
## Platforms Supported
64

75
- [x] iOS (both UIWebView and WKWebView)
86
- [x] Android
9-
- [ ] Windows 10 (coming soon)
10-
11-
## Versioning
12-
13-
If you need the exact same WebView as the one from react-native, please use version **2.0.0**. Future versions will follow [semantic versioning](https://semver.org/).
147

158
## Getting Started
169

@@ -19,8 +12,6 @@ $ yarn add react-native-webview-crossplatform
1912
$ react-native link react-native-webview-crossplatform
2013
```
2114

22-
Read our [Getting Started Guide](./docs/Getting-Started.md) for more.
23-
2415
## Usage
2516

2617
Import the `WebView` component from `react-native-webview-crossplatform` and use it like so:
@@ -50,26 +41,6 @@ class MyWebComponent extends Component {
5041

5142
For more, read the [API Reference](./docs/Reference.md) and [Guide](./docs/Guide.md).
5243

53-
## Migrate from React Native core WebView to React Native WebView
54-
55-
Simply install React Native WebView and then use it in place of the core WebView. Their APIs are currently identical, except that this package defaults `useWebKit={true}` unlike the built-in WebView.
56-
57-
### Contributor Notes
58-
59-
- I've removed all PropTypes for now. Instead, we'll be using Flow types. TypeScript types will be added at a later date.
60-
- UIWebView is not tested fully and you will encounter some yellow warning boxes. Since it is deprecated, we don't intend to put a lot of time into supporting it, but feel free to submit PRs if you have a special use case. Note that you will need to specify `useWebKit={false}` to use UIWebView
61-
- After pulling this repo and installing all dependencies, you can run flow on iOS and Android-specific files using the commands:
62-
- `yarn test:ios:flow` for iOS
63-
- `yarn test:android:flow` for Android
64-
- If you want to add another React Native platform to this repository, you will need to create another `.flowconfig` for it. If your platform is `example`, copy the main flowconfig and rename it to `.flowconfig.example`. Then edit the config to ignore other platforms, and add `.*/*[.]example.js` to the ignore lists of the other platforms. Then add an entry to `package.json` like this:
65-
- `"test:example:flow": "flow check --flowconfig-name .flowconfig.example"`
66-
- Currently you need to install React Native 0.57 to be able to test these types - `flow check` will not pass against 0.56.
67-
68-
## Maintainers
69-
70-
- [Jamon Holmgren](https://github.com/jamonholmgren) ([Twitter @jamonholmgren](https://twitter.com/jamonholmgren)) from [Infinite Red](https://infinite.red/react-native)
71-
- [Thibault Malbranche](https://github.com/Titozzz) ([Twitter @titozzz](https://twitter.com/titozzz)) from [Brigad](https://brigad.co/about)
72-
7344
## License
7445

7546
MIT

0 commit comments

Comments
 (0)