Skip to content

Commit 10488b6

Browse files
authored
Update README to reflect current status of the CLI (#2438)
1 parent 0b03c5c commit 10488b6

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# React Native CLI
1+
# React Native Community CLI
22

3-
Command line tools that ship with [`react-native`](https://github.com/facebook/react-native) in form of the `@react-native-community/cli` package.
4-
5-
> It exposes `react-native` binary, so you can call `yarn react-native` or `npx react-native` directly from your project.
3+
Command line tools that help you build apps with [`react-native`](https://github.com/facebook/react-native), shipped as the `@react-native-community/cli` NPM package.
64

75
[![Build Status][build-badge]][build] [![Version][version-badge]][package] [![MIT License][license-badge]][license] [![PRs Welcome][prs-welcome-badge]][prs-welcome] [![Lean Core Extracted][lean-core-badge]][lean-core]
86

@@ -57,31 +55,35 @@ This monorepository contains tools and helpers for React Native projects in form
5755
Run the following command in your terminal prompt:
5856

5957
```sh
60-
npx react-native@latest init MyApp
58+
npx @react-native-community/cli@latest init MyApp
6159
```
6260

6361
## Usage in an existing React Native project
6462

65-
Once you're inside an existing project, a local `react-native` binary will be available for you to use. Feel free to use Yarn to call it directly.
63+
Once you're inside an existing project, you can run a series of commands to interact with your projects by using the `rnc-cli` binary.
6664

6765
Example running `start` command in terminal:
6866

6967
```sh
70-
yarn react-native start
71-
# or:
72-
npx react-native start
68+
yarn rnc-cli start
7369
```
7470

7571
You can also add npm scripts to call it with whichever package manager you use:
7672

7773
```json
7874
{
7975
"scripts": {
80-
"start": "react-native start"
76+
"start": "rnc-cli start"
8177
}
8278
}
8379
```
8480

81+
to call it as
82+
83+
```sh
84+
yarn start
85+
```
86+
8587
## Updating the CLI
8688

8789
> [!WARNING]

0 commit comments

Comments
 (0)