docs(create-rsbuild): update README (#3323)

web-infra-dev · Aug 30, 2024 · a03b2b0 · a03b2b0
1 parent 1e338b1
commit a03b2b0
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 26 deletions.
diff --git a/packages/create-rsbuild/README.md b/packages/create-rsbuild/README.md
@@ -2,9 +2,24 @@
   <a href="https://rsbuild.dev" target="blank"><img src="https://github.com/web-infra-dev/rsbuild/assets/7237365/84abc13e-b620-468f-a90b-dbf28e7e9427" alt="Rsbuild Logo" /></a>
 </p>
 
-# Rsbuild
+# create-rsbuild
 
-The Rspack-based build tool. It's fast, out-of-the-box and extensible.
+Create a new Rsbuild project.
+
+Using `npm create`:
+
+```bash
+npm create rsbuild@latest
+```
+
+Using CLI flags:
+
+```bash
+npx create-rsbuild --dir my-project --template react
+
+# Using abbreviations
+npx create-rsbuild -d my-project -t react
+```
 
 ## Documentation
 

diff --git a/packages/create-rsbuild/package.json b/packages/create-rsbuild/package.json
@@ -32,7 +32,7 @@
     "typescript": "^5.5.2"
   },
   "dependencies": {
-    "create-rstack": "1.0.0"
+    "create-rstack": "1.0.1"
   },
   "engines": {
     "node": ">=16.7.0"

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/website/docs/en/guide/advanced/env-vars.mdx b/website/docs/en/guide/advanced/env-vars.mdx
@@ -130,7 +130,7 @@ If several of the above files exist at the same time, they will all be loaded, w
 
 ### Env Mode
 
-Rsbuild also supports reading `.env.[mode]` and `.env.[mode].local` files. You can specify the env mode using the `--env-mode <mode>` CLI option.
+Rsbuild also supports reading `.env.[mode]` and `.env.[mode].local` files. You can specify the env mode using the `--env-mode <mode>` flag.
 
 For example, set the env mode as `test`:
 

diff --git a/website/docs/en/guide/start/quick-start.mdx b/website/docs/en/guide/start/quick-start.mdx
@@ -91,7 +91,7 @@ If you need to create a project in the current directory, you can set the target
 
 ### Quick Creation
 
-`create-rsbuild` provides some CLI options. By setting these CLI options, you can skip the interactive selection steps and create the project with one command.
+[create-rsbuild](https://www.npmjs.com/package/create-rsbuild) provides some CLI flags. By setting these CLI flags, you can skip the interactive selection steps and create the project with one command.
 
 For example, to create a React project in the `my-project` directory with one command:
 
@@ -102,7 +102,7 @@ npx create-rsbuild --dir my-project --template react
 npx create-rsbuild -d my-project -t react
 ```
 
-The complete CLI options for `create-rsbuild` are as follows:
+All the CLI flags of `create-rsbuild`:
 
 ```text
 Usage: create-rsbuild [options]

diff --git a/website/docs/zh/guide/start/quick-start.mdx b/website/docs/zh/guide/start/quick-start.mdx
@@ -96,7 +96,7 @@ Biome 提供与 ESLint 和 Prettier 相似的代码检查和格式化功能。
 
 ### 快速创建
 
-`create-rsbuild` 提供了一些 CLI 选项。通过设置这些 CLI 选项，你可以跳过交互式的选择步骤，一键创建项目。
+[create-rsbuild](https://www.npmjs.com/package/create-rsbuild) 提供了一些 CLI 选项。通过设置这些 CLI 选项，你可以跳过交互式的选择步骤，一键创建项目。
 
 比如，一键创建 React 项目到 `my-project` 目录：