Skip to content

Commit aa18f4d

Browse files
committed
fix(documentation): update documentation to reflect TypeScript changes
release-npm
1 parent 979cf93 commit aa18f4d

File tree

3 files changed

+4
-8
lines changed

3 files changed

+4
-8
lines changed

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ Since you probably don't want to blind-code the whole plugin use the following c
3131
npm run app
3232
```
3333

34-
This will create an app inside `/app` where except `/app/App.js` all files are gitignored. Here you can try out various use cases of the plugin and use this as a way to demonstrate the plugin.
34+
This will create an app inside `/app` where except `/app/App.tsx` all files are gitignored. Here you can try out various use cases of the plugin and use this as a way to demonstrate the plugin. The app can be started as usual by running `npm run ios` or `npm run android` inside the `/app` folder.
3535

3636
```
3737
npm run watch
3838
```
3939

40-
Running the above will watch the plugin source code for any kind of changes, rebuild and copy over the changes to the app which will then automatically hot-reload.
40+
Running the above in the root folder will watch the plugin source code for any kind of changes, rebuild and copy over the changes to the app which will then automatically hot-reload.
4141

4242
Don't forget to always check your plugin both on Android and iOS even though your not using native code the provided components might still differ depending on the platform.
4343

@@ -50,10 +50,6 @@ npm test
5050
npm run test:watch # Keep watching and retesting on changes.
5151
```
5252

53-
## TypeScript
54-
55-
Flow the type checker native to React Native has largely failed to gain popularity and also lags behind TypeScript in many other important aspects. Since a good chunk of bigger React Native projects are written in TypeScript plugins should provide type definitions.
56-
5753
## Troubleshooting
5854

5955
If you have issues building the app for iOS try the following

customize.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { join } from 'path'
22
import { existsSync, readFileSync, writeFileSync } from 'fs'
33

44
const files = [
5-
'app/App.js',
5+
'app/App.tsx',
66
'test/basic.test.tsx',
77
'test/docs.test.tsx',
88
'test/tsconfig.json',

index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,6 @@ execSync('npm install --legacy-peer-deps', {
5656
console.log('')
5757
console.log(`😃 Created new plugin called ${name.regular} in ${destinationDirectory}.`)
5858
console.log(`🛠️ Start coding in the file ./index.tsx.`)
59-
console.log(`🛠️ To preview the plugin edit app/App.js and create a RN installation with:`)
59+
console.log(`🛠️ To preview the plugin edit app/App.tsx and create a RN installation with:`)
6060
console.log(`🐚 cd ${name.regular}`)
6161
console.log('🐚 npm run app')

0 commit comments

Comments
 (0)