Skip to content

Commit 73b5d17

Browse files
committed
docs: update README
1 parent d6c3b0d commit 73b5d17

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,22 @@
88
<a href="https://github.com/rstackjs/rstack/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" /></a>
99
</p>
1010

11-
Rstack CLI brings the Rstack toolchain together for JavaScript development, with one CLI and one consistent workflow.
11+
Rstack CLI brings the Rstack toolchain together for JavaScript development, with one CLI, one configuration, and one consistent workflow.
12+
13+
It also covers local development needs outside Rstack's scope, with Oxfmt formatting and lint-staged commands.
1214

1315
| Command | Description | Powered by |
1416
| ------------ | ----------------------------- | --------------------------------------------------------- |
1517
| `rs dev` | Start a local app dev server | [Rsbuild](https://github.com/web-infra-dev/rsbuild) |
1618
| `rs build` | Create a production app build | [Rsbuild](https://github.com/web-infra-dev/rsbuild) |
1719
| `rs preview` | Preview the production build | [Rsbuild](https://github.com/web-infra-dev/rsbuild) |
18-
| `rs lib` | Build library outputs | [Rslib](https://github.com/web-infra-dev/rslib) |
19-
| `rs doc` | Develop and build docs | [Rspress](https://github.com/web-infra-dev/rspress) |
2020
| `rs test` | Run the test suite | [Rstest](https://github.com/web-infra-dev/rstest) |
2121
| `rs lint` | Lint and type-check code | [Rslint](https://github.com/web-infra-dev/rslint) |
22+
| `rs lib` | Build library outputs | [Rslib](https://github.com/web-infra-dev/rslib) |
23+
| `rs doc` | Develop and build docs (TODO) | [Rspress](https://github.com/web-infra-dev/rspress) |
24+
| `rs fmt` | Format code (TODO) | [Oxfmt](https://github.com/oxc-project/oxc) |
2225
| `rs staged` | Run tasks for staged files | [lint-staged](https://github.com/lint-staged/lint-staged) |
2326

24-
It also covers common local development tasks, with formatting powered by [Oxfmt](https://github.com/oxc-project/oxc) and staged-file commands powered by [lint-staged](https://github.com/lint-staged/lint-staged), giving Rstack projects a complete development experience out of the box.
25-
2627
Rstack CLI fits into your existing project workflow. It does not replace your runtime, package manager, or task runner, such as [pnpm](https://github.com/pnpm/pnpm), [Bun](https://github.com/oven-sh/bun), [Turborepo](https://github.com/vercel/turborepo), [Nx](https://github.com/nrwl/nx), and [Nub](https://github.com/nubjs/nub).
2728

2829
## Current status

0 commit comments

Comments
 (0)