Skip to content

Update documentation to have CLI instructions before the usage #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 21, 2021
Merged

Update documentation to have CLI instructions before the usage #199

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6716c37
Update documentation to have CLI instructions before the usage
iepsen Mar 24, 2021
c84bec8
Move back the old cli instructions to the bottom
iepsen Jul 21, 2021
6665b56
Add usage instructions to ignore existing npx on the PATH
iepsen Jul 21, 2021
b43638f
Add a clear message regarding to the --ignore-existing flag usage
iepsen Jul 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.\* |

### 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`).
## :warning: React Native CLI

Further information can be found here: https://github.com/react-native-community/cli#about
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.


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).
Expand Down