Skip to content

Commit

Permalink
docs: sync status with current state of upgrade command (#1994)
Browse files Browse the repository at this point in the history
* docs: sync status with current state of `upgrade` command

* Update docs/commands.md

Co-authored-by: Michał Pierzchała <thymikee@gmail.com>

---------

Co-authored-by: Michał Pierzchała <thymikee@gmail.com>
  • Loading branch information
szymonrybczak and thymikee authored Jul 3, 2023
1 parent 29ee181 commit 1c04cbd
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,11 +112,7 @@ Create project with custom package name for Android and bundle identifier for iO
Usage:

```sh
react-native upgrade [npm-version]
react-native upgrade
```

Upgrade your app's template files to the specified or latest npm version using [rn-diff-purge](https://github.com/react-native-community/rn-diff-purge) project. Only valid semver versions are allowed.

Using this command is a recommended way of upgrading relatively simple React Native apps with not too many native libraries linked. The more iOS and Android build files are modified, the higher chance for a conflicts. The command will guide you on how to continue upgrade process manually in case of failure.

_Note: If you'd like to upgrade using this method from React Native version lower than 0.59.0, you may use a standalone version of this CLI: `npx @react-native-community/cli upgrade`._
This command generates a relevant link to the [Upgrade Helper](https://react-native-community.github.io/upgrade-helper/) to help you upgrade manually.

0 comments on commit 1c04cbd

Please sign in to comment.