You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
doc: apply general documentation updates - February 2021 (#424)
for upcoming 0.20.0 release
* React Native pre-0.63 support is now deprecated (see issue #423)
* known issue with React Native 0.64 (rc) on iOS (see issue #422)
* add link to @otobank fork (see #425)
* document --use-apple-networking as EXPERIMENTAL & NOT SUPPORTED
(see issue #426)
- generated example app with symlink by default, has known issue with adding dependencies to the library root - see [issue #308](https://github.com/brodybits/create-react-native-module/issues/308)
- Recommended React Native version: `0.63`; known issue with React Native `0.64(rc)` on iOS - see issue [`#422`](https://github.com/brodybits/create-react-native-module/issues/422)
32
+
- generated example app with symlink by default, has known issue with adding dependencies to the library root - see issue [`#308`](https://github.com/brodybits/create-react-native-module/issues/308)
32
33
- Platform fork support
33
34
- tvOS platform fork
34
35
- requires use of `--tvos-enabled` option as documented below
35
-
- requires the [`react-native-tvos`](https://www.npmjs.com/package/react-native-tvos) fork, with minimum version of 0.60 ref: [react-native-community/react-native-tvos#11](https://github.com/react-native-community/react-native-tvos/issues/11)), [issue #95](https://github.com/brodybits/create-react-native-module/issues/95)
36
+
- requires the [`react-native-tvos`](https://www.npmjs.com/package/react-native-tvos) fork, with minimum version of `0.60` ref:
- Windows - no longer supported for reasons discussed in issues [#23](https://github.com/brodybits/create-react-native-module/issues/23) and [#43](https://github.com/brodybits/create-react-native-module/issues/43) (existing Windows C# template is kept in `unsupported-platforms` for now (at least) and further discussion would be welcome in a new issue on GitHub)
38
41
- for future consideration: macOS (see [issue #94](https://github.com/brodybits/create-react-native-module/issues/94))
@@ -46,6 +49,7 @@ Why not use `react-native new-library`? Unfortunately that command doesn't creat
46
49
47
50
### Alternatives
48
51
52
+
-[`otobank/create-react-native-module`](https://github.com/otobank/create-react-native-module) - fork with TypeScript, Swift, and Kotlin support, with some other updates and some less useful features removed; see also issue [`#425`](https://github.com/brodybits/create-react-native-module/issues/425)
49
53
-[`brodybits/react-native-module-init`](https://github.com/brodybits/react-native-module-init) - new interactive CLI that uses the templates from this utiity
50
54
-[`react-native-community/bob`](https://github.com/react-native-community/bob) - opinionated, interactive library CLI that is designed to support both native libraries and libraries with web support
51
55
@@ -100,7 +104,7 @@ Options:
100
104
--author-name <authorName> The author's name (Default: `Your Name`)
101
105
--author-email <authorEmail> The author's email (Default: `[email protected]`)
102
106
--license <license> The license type (Default: `MIT`)
103
-
--use-apple-networking [iOS] Use `AFNetworking` dependency as a sample in the podspec & use it from the iOS code
107
+
--use-apple-networking [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: Use `AFNetworking` dependency as a sample in the podspec & use it from the iOS code - see issue #426
104
108
--generate-example Generate an example project and add the library module to it with symlink by defult, with overwrite of example metro.config.js to add workaround for Metro symlink issue - requires both react-native-cli and yarn to be installed globally
105
109
--example-file-linkage DEPRECATED: do `yarn add file:../` instead of `yarn add link:../` in a generated example project, and add a postinstall workaround script, with no overwrite of example metro.config.js
106
110
--example-name <exampleName> Name for the example project (default: `example`)
@@ -138,7 +142,7 @@ createLibraryModule({
138
142
authorName:String, /* The author's name (Default: `Your Name`) */
139
143
authorEmail:String, /* The author's email (Default: `[email protected]`) */
140
144
license:String, /* The license type of this library (Default: `MIT`) */
141
-
useAppleNetworking:Boolean, /* [iOS] Use `AFNetworking` dependency as a sample in the podspec & use it from the iOS code (Default: false) */
145
+
useAppleNetworking:Boolean, /* [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: Use `AFNetworking` dependency as a sample in the podspec & use it from the iOS code - see issue #426 (Default: false) */
142
146
generateExample:Boolean, /* Generate an example project and add the library module to it with symlink by defult, with overwrite of example metro.config.js to add workaround for Metro symlink issue - requires both react-native-cli and yarn to be installed globally (Default: false) */
143
147
exampleFileLinkage:Boolean, /* DEPRECATED: do `yarn add file:../` instead of `yarn add link:../` in a generated example project, and add a postinstall workaround script, with no overwrite of example metro.config.js (Default: false) */
144
148
exampleName:String, /* Name for the example project (Default: `example`) */
0 commit comments