Browse Source

Add note to README.md about flow types

empyrical 6 years ago
parent
commit
66ecb8b324
No account linked to committer's email address
1 changed files with 6 additions and 1 deletions
  1. 6
    1
      README.md

+ 6
- 1
README.md View File

@@ -51,8 +51,13 @@ Simply install React Native WebView and then use it in place of the core WebView
51 51
 
52 52
 ### Contributor Notes
53 53
 
54
-* I've removed all PropTypes for now. Instead, we'll be moving toward Flow or TypeScript at a later date
54
+* I've removed all PropTypes for now. Instead, we'll be using Flow types. TypeScript types will be added at a later date.
55 55
 * 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
56
+* After pulling this repo and installing all dependencies, you can run flow on iOS and Android-specific files using the commands:
57
+  * `yarn flow` or `npm run flow` for iOS
58
+  * `yarn flow-android` or `npm run flow-android` for Android
59
+* 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:
60
+  * `    "flow-example": "flow check --flowconfig-name .flowconfig.example"`
56 61
 
57 62
 ## Maintainers
58 63