Update documentation to have CLI instructions before the usage (#199)

* Update documentation to have CLI instructions before the usage

* Move back the old cli instructions to the bottom

* Add usage instructions to ignore existing npx on the PATH

* Add a clear message regarding to the --ignore-existing flag usage
This commit is contained in:
Marcelo Iepsen authored and GitHub committed 2021-07-21 11:39:29 +02:00
1 parent df72937d6c
commit d66ebbff86
1 file changed
+13 -10
+13 -10
View File
@@ -41,19 +41,22 @@ See the below table to find out which version of the template to use.
#### React Native <=> Template Version
| React Native | Template |
|--- |--- |
| 0.64 | 6.6.* |
| 0.63 | 6.5.* |
| 0.62 | 6.4.* |
| 0.61 | 6.3.* |
| 0.60 | 6.2.* |
| React Native | Template |
| ------------ | -------- |
| 0.64 | 6.6.\* |
| 0.63 | 6.5.\* |
| 0.62 | 6.4.\* |
| 0.61 | 6.3.\* |
| 0.60 | 6.2.\* |
## :warning: React Native CLI
This template only works with the new CLI. Make sure you have uninstalled the legacy `react-native-cli` first (`npm uninstall -g react-native-cli`), for the below command to work. If you wish to not use `npx`, you can also install the new CLI globally (`npm i -g @react-native-community/cli` or `yarn global add @react-native-community/cli`).
If you tried the above and still get the *react-native-template-react- native-template-typescript: Not found error*, please try adding the [--ignore-existing](https://github.com/npm/npx#description) flag to the npx call to force npx to ignore any locally installed versions of the CLI.
### Note on the legacy CLI
There seems to be quite some confusion about the legacy CLI. This template only works with the new CLI. Make sure you have uninstalled the legacy `react-native-cli` first (`npm uninstall -g react-native-cli`), for the below command to work. If you wish to not use `npx`, you can also install the new CLI globally (`npm i -g @react-native-community/cli` or `yarn global add @react-native-community/cli`).
Further information can be found here: https://github.com/react-native-community/cli#about
## :computer: Contributing
Contributions are very welcome. Please check out the [contributing document](CONTRIBUTING.md).