Browse Source

Update README.md

Thibault Malbranche 5 years ago
parent
commit
a4c6f210cf
No account linked to committer's email address
1 changed files with 4 additions and 11 deletions
  1. 4
    11
      README.md

+ 4
- 11
README.md View File

@@ -11,7 +11,6 @@ _Garrett McCullough, mobile engineer at Virta Health_
11 11
 
12 12
 - [x] iOS (both UIWebView and WKWebView)
13 13
 - [x] Android
14
-- [ ] Windows 10 (coming soon)
15 14
 
16 15
 _Note: React Native WebView is not currently supported by Expo unless you "eject"._
17 16
 
@@ -19,6 +18,8 @@ _Note: React Native WebView is not currently supported by Expo unless you "eject
19 18
 
20 19
 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/).
21 20
 
21
+Please note that version >= 5.0.3 only support **react-native >=0.58**
22
+
22 23
 ## Getting Started
23 24
 
24 25
 ```
@@ -44,7 +45,6 @@ class MyWebComponent extends Component {
44 45
       <WebView
45 46
         source={{ uri: "https://infinite.red/react-native" }}
46 47
         style={{ marginTop: 20 }}
47
-        onLoadProgress={e => console.log(e.nativeEvent.progress)}
48 48
       />
49 49
     );
50 50
   }
@@ -61,16 +61,9 @@ Simply install React Native WebView and then use it in place of the core WebView
61 61
 
62 62
 - If you're getting `Invariant Violation: Native component for "RNCWKWebView does not exist"` it likely means you forgot to run `react-native link` or there was some error with the linking process
63 63
 
64
-### Contributor Notes
64
+## Contributing
65 65
 
66
-- I've removed all PropTypes for now. Instead, we'll be using Flow types. TypeScript types will be added at a later date.
67
-- 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
68
-- After pulling this repo and installing all dependencies, you can run flow on iOS and Android-specific files using the commands:
69
-  - `yarn test:ios:flow` for iOS
70
-  - `yarn test:android:flow` for Android
71
-- 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:
72
-  - `"test:example:flow": "flow check --flowconfig-name .flowconfig.example"`
73
-- Currently you need to install React Native 0.57 to be able to test these types - `flow check` will not pass against 0.56.
66
+See [Contributing.md](https://github.com/react-native-community/react-native-webview/blob/master/docs/Contributing.md)
74 67
 
75 68
 ## Maintainers
76 69