Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: udpate examples README #3904

Merged
merged 1 commit into from Sep 30, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 1 addition & 4 deletions examples/README.md
Expand Up @@ -11,14 +11,11 @@ An example should be as minimal as possible and consists of at least:
- A description of what should happen when running the example.
- A `webpack.config.js` file containing the `webpack` configuration for the example app.

## API versus CLI
## API

API examples can be found in the `api` directory. These examples demonstrate how
to access and run `webpack-dev-server` directly in your application / script.

CLI examples can be found in the `cli` directory. These examples demonstrate how
to run `webpack-dev-server` from the command line in your console / terminal.

## Notes

- Each example's `webpack` config is wrapped with `util.setup`; a helper function
Expand Down