Skip to content

Commit bc86316

Browse files
authored
Revise README, symlink to main package (#2807)
1 parent 4b32362 commit bc86316

2 files changed

Lines changed: 81 additions & 146 deletions

File tree

README.md

Lines changed: 0 additions & 142 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
./packages/cli/README.md

packages/cli/README.md

Lines changed: 80 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,83 @@
1-
# React Native CLI
1+
# React Native Community CLI
22

3-
Command line tools to interact with React Native projects.
3+
[![npm package](https://img.shields.io/npm/v/@react-native-community/cli?label=latest%20stable)](https://www.npmjs.com/package/@react-native-community/cli)
44

5-
This package contains source code for `@react-native-community/cli`, the actual CLI that comes bundled with React Native. You don't need to install it separately in your project.
5+
Command line tools for building apps with [React Native](https://reactnative.dev), shipped as the `@react-native-community/cli` npm package.
66

7-
See the [list of available commands](../../docs/commands.md).
7+
See also the [Community Template](https://github.com/react-native-community/template).
8+
9+
## Docs
10+
11+
- [Initializing a new project](https://github.com/react-native-community/cli/tree/main/docs/init.md)
12+
- [Configuration](https://github.com/react-native-community/cli/tree/main/docs/configuration.md)
13+
- [Commands](https://github.com/react-native-community/cli/tree/main/docs/commands.md)
14+
- [Plugins](https://github.com/react-native-community/cli/tree/main/docs/plugins.md)
15+
- [Autolinking](https://github.com/react-native-community/cli/tree/main/docs/autolinking.md)
16+
17+
## Compatibility
18+
19+
Our release cycle is independent of `react-native`.
20+
21+
> [!Warning]
22+
> **Important**: `@react-native-community/cli` is designed to work with specific `react-native` versions. We do not recommend updating CLI independently, as it may cause unexpected issues.
23+
24+
| `@react-native-community/cli` | `react-native` |
25+
| ------------------------------------------------------------------ | ------------------------- |
26+
| [^20.0.0](https://github.com/react-native-community/cli/tree/main) | ^0.81.0, ^0.82.0, ^0.83.0, ^0.84.0, ^0.85.0 |
27+
| [^19.0.0](https://github.com/react-native-community/cli/tree/19.x) | ^0.80.0 |
28+
| [^18.0.0](https://github.com/react-native-community/cli/tree/18.x) | ^0.79.0 |
29+
| [^15.0.0](https://github.com/react-native-community/cli/tree/15.x) | ^0.76.0, ^0.77.0, ^0.78.0 |
30+
31+
[Previous versions](https://github.com/react-native-community/cli/blob/b26aa65/README.md)
32+
33+
## Creating a new React Native project
34+
35+
Run the following command in your terminal prompt:
36+
37+
```sh
38+
npx @react-native-community/cli@latest init MyApp
39+
```
40+
41+
See more options for the `init` command [here](https://github.com/react-native-community/cli/blob/main/docs/init.md).
42+
43+
## Usage in an existing React Native project
44+
45+
Once installed, you can run commands to interact with your projects by using the `rnc-cli` binary.
46+
47+
Example running `start` command in terminal:
48+
49+
```sh
50+
yarn rnc-cli start
51+
```
52+
53+
You can also add npm scripts to call it with whichever package manager you use:
54+
55+
```json
56+
{
57+
"scripts": {
58+
"start": "rnc-cli start"
59+
}
60+
}
61+
```
62+
63+
to call it as
64+
65+
```sh
66+
yarn start
67+
```
68+
69+
## Maintainers
70+
71+
- Michał Pierzchała ([**@thymikee**](https://github.com/thymikee)) - [Callstack](https://callstack.com)
72+
- Alex Hunt ([**@huntie**](https://github.com/huntie)) - [Meta](https://meta.com)
73+
74+
Previously:
75+
76+
- Szymon Rybczak ([**@szymonrybczak**](https://github.com/szymonrybczak))
77+
- Mike Grabowski ([**@grabbou**](https://github.com/grabbou)) - [Callstack](https://callstack.com)
78+
- Kacper Wiszczuk ([**@esemesek**](https://github.com/esemesek)) - [Callstack](https://callstack.com)
79+
- Adam Trzciński ([**@adamTrz**](https://github.com/adamTrz)) - [Callstack](https://callstack.com)
80+
81+
## License
82+
83+
Everything inside this repository is [MIT licensed](./LICENSE).

0 commit comments

Comments
 (0)