Skip to content

Commit 5a93b50

Browse files
authored
docs: update README.md (#109)
1 parent 7e70039 commit 5a93b50

1 file changed

Lines changed: 13 additions & 16 deletions

File tree

README.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ First of all, install `@rspack/dev-server` and `@rspack/core` by your favorite p
1919

2020
```bash
2121
# npm
22-
$ npm install @rspack/dev-server @rspack/core --save-dev
22+
$ npm install -D @rspack/dev-server @rspack/core
2323

2424
# yarn
25-
$ yarn add @rspack/dev-server @rspack/core --dev
25+
$ yarn add -D @rspack/dev-server @rspack/core
2626

2727
# pnpm
28-
$ pnpm add @rspack/dev-server @rspack/core --save-dev
28+
$ pnpm add -D @rspack/dev-server @rspack/core
2929

3030
# bun
31-
$ bun add @rspack/dev-server @rspack/core -D
31+
$ bun add -D @rspack/dev-server @rspack/core
3232
```
3333

3434
## Usage
@@ -43,16 +43,16 @@ You can install it in your project by:
4343

4444
```bash
4545
# npm
46-
$ npm install @rspack/cli --save-dev
46+
$ npm install -D @rspack/cli
4747

4848
# yarn
49-
$ yarn add @rspack/cli --dev
49+
$ yarn add -D @rspack/cli
5050

5151
# pnpm
52-
$ pnpm add @rspack/cli --save-dev
52+
$ pnpm add -D @rspack/cli
5353

5454
# bun
55-
$ bun add @rspack/cli -D
55+
$ bun add -D @rspack/cli
5656
```
5757

5858
And then start the development server by:
@@ -72,28 +72,27 @@ While starting the development server, you can specify the configuration by the
7272
```js
7373
// rspack.config.mjs
7474
export default {
75-
// ...
7675
devServer: {
7776
// the configuration of the development server
7877
port: 8080,
7978
},
8079
};
8180
```
8281

83-
> See [DevServer](https://rspack.rs/config/dev-server) for all configuration options.
82+
> See [Rspack - devServer](https://rspack.rs/config/dev-server) for all configuration options.
8483
8584
### With the API
8685

8786
While it's recommended to run `@rspack/dev-server` via the CLI, you may also choose to start a server via the API.
8887

8988
```js
9089
import { RspackDevServer } from '@rspack/dev-server';
91-
import rspack from '@rspack/core';
92-
import rspackConfig from './rspack.config.mjs';
90+
import { rspack } from '@rspack/core';
91+
import config from './rspack.config.mjs';
9392

94-
const compiler = rspack(rspackConfig);
93+
const compiler = rspack(config);
9594
const devServerOptions = {
96-
...rspackConfig.devServer,
95+
...config.devServer,
9796
// override
9897
port: 8888,
9998
};
@@ -105,8 +104,6 @@ server.startCallback(() => {
105104
});
106105
```
107106

108-
> Cause `@rspack/dev-server` is based on `webpack-dev-server@5`, you can see the [webpack-dev-server API](https://webpack.js.org/api/webpack-dev-server/) for more methods of the server instance.
109-
110107
## Credits
111108

112109
This plugin is forked from [webpack-dev-server](https://github.com/webpack/webpack-dev-server), and is used to smooth out some differences between rspack and webpack, while also providing rspack-specific new features.

0 commit comments

Comments
 (0)