Skip to content

Commit ffedb09

Browse files
authored
docs: update create-app readmes (#512)
* docs: update create-app readmes * changeset
1 parent fef7e61 commit ffedb09

File tree

4 files changed

+20
-14
lines changed

4 files changed

+20
-14
lines changed

.changeset/three-kings-check.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'create-rock': patch
3+
'rock': patch
4+
---
5+
6+
docs: update create-app readmes

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,23 +46,23 @@ Rock is designed for incremental adoption. Whether you're just starting with Rea
4646
To migrate an existing project, open a terminal in your project root and run:
4747

4848
```shell
49-
npm create rock-app
49+
npm create rock
5050
```
5151

5252
### Creating a new project
5353

5454
To create a fresh React Native app with Rock, open a terminal and run:
5555

5656
```shell
57-
npm create rock-app
57+
npm create rock
5858
```
5959

6060
### Adding to an existing native project
6161

6262
To add React Native to an existing iOS or Android app with Rock, use our Brownfield plugins:
6363

6464
```shell
65-
npm create rock-app
65+
npm create rock
6666
# ...
6767
◆ What plugins do you want to start with?
6868
│ ◼ brownfield-ios

packages/cli/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,23 +46,23 @@ Rock is designed for incremental adoption. Whether you're just starting with Rea
4646
To migrate an existing project, open a terminal in your project root and run:
4747

4848
```shell
49-
npm create rock-app
49+
npm create rock
5050
```
5151

5252
### Creating a new project
5353

5454
To create a fresh React Native app with Rock, open a terminal and run:
5555

5656
```shell
57-
npm create rock-app
57+
npm create rock
5858
```
5959

6060
### Adding to an existing native project
6161

6262
To add React Native to an existing iOS or Android app with Rock, use our Brownfield plugins:
6363

6464
```shell
65-
npm create rock-app
65+
npm create rock
6666
# ...
6767
◆ What plugins do you want to start with?
6868
│ ◼ brownfield-ios

packages/create-app/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A CLI tool for creating new Rock projects with customizable templates, platforms
55
## Usage
66

77
```bash
8-
npm create rock-app my-app
8+
npm create rock
99
```
1010

1111
## Features
@@ -32,19 +32,19 @@ npm create rock-app my-app
3232

3333
```bash
3434
# Create a basic project
35-
npm create rock-app my-app
35+
npm create rock
3636

3737
# Create with specific platforms
38-
npm create rock-app my-app --platforms ios android
38+
npm create rock --platforms ios android
3939

4040
# Create with brownfield plugins
41-
npm create rock-app my-app --plugins brownfield-ios brownfield-android
41+
npm create rock --plugins @rock-js/plugin-brownfield-ios @rock-js/plugin-brownfield-android
4242

4343
# Create with Re.Pack bundler
44-
npm create rock-app my-app --bundler repack
44+
npm create rock --bundler repack
4545

4646
# Create and install dependencies
47-
npm create rock-app my-app --install
47+
npm create rock --install
4848
```
4949

5050
## Available Templates
@@ -58,8 +58,8 @@ npm create rock-app my-app --install
5858

5959
## Available Plugins
6060

61-
- **brownfield-ios** - iOS brownfield integration
62-
- **brownfield-android** - Android brownfield integration
61+
- **@rock-js/plugin-brownfield-ios** - iOS brownfield integration
62+
- **@rock-js/plugin-brownfield-android** - Android brownfield integration
6363

6464
## Available Bundlers
6565

0 commit comments

Comments
 (0)