Skip to content

Commit 74deac7

Browse files
authored
docs: add API usage in README (#3973)
1 parent 8f66c22 commit 74deac7

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ fast in-memory access to the webpack assets.
2626
- [Usage](#usage)
2727
- [With the CLI](#with-the-cli)
2828
- [With NPM Scripts](#with-npm-scripts)
29+
- [With the API](#with-the-api)
2930
- [The Result](#the-result)
3031
- [Browser Support](#browser-support)
3132
- [Support](#support)
@@ -201,6 +202,12 @@ npm run serve
201202
NPM will automagically reference the binary in `node_modules` for you, and
202203
execute the file or command.
203204

205+
### With the API
206+
207+
While it's recommended to run webpack-dev-server via the CLI, you may also choose to start a server via the API.
208+
209+
See the related [API documentation for `webpack-dev-server`](https://webpack.js.org/api/webpack-dev-server/).
210+
204211
### The Result
205212

206213
Either method will start a server instance and begin listening for connections

0 commit comments

Comments
 (0)