Skip to content

Commit d66ebbf

Browse files
authored
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
1 parent df72937 commit d66ebbf

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,19 +41,22 @@ See the below table to find out which version of the template to use.
4141

4242
#### React Native <=> Template Version
4343

44-
| React Native | Template |
45-
|--- |--- |
46-
| 0.64 | 6.6.* |
47-
| 0.63 | 6.5.* |
48-
| 0.62 | 6.4.* |
49-
| 0.61 | 6.3.* |
50-
| 0.60 | 6.2.* |
44+
| React Native | Template |
45+
| ------------ | -------- |
46+
| 0.64 | 6.6.\* |
47+
| 0.63 | 6.5.\* |
48+
| 0.62 | 6.4.\* |
49+
| 0.61 | 6.3.\* |
50+
| 0.60 | 6.2.\* |
5151

52-
### Note on the legacy CLI
53-
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`).
52+
## :warning: React Native CLI
5453

55-
Further information can be found here: https://github.com/react-native-community/cli#about
54+
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`).
55+
56+
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.
5657

58+
59+
Further information can be found here: https://github.com/react-native-community/cli#about
5760
## :computer: Contributing
5861

5962
Contributions are very welcome. Please check out the [contributing document](CONTRIBUTING.md).

0 commit comments

Comments
 (0)