Skip to content

docs: update bonjour example #3262

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

Merged
merged 1 commit into from
May 7, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions examples/cli/bonjour/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,30 @@ npm run webpack-dev-server -- --bonjour

A Zeroconf broadcast should occur, containing data with a type of `http` and a
subtype of `webpack`.

# Bonjour options

Allows options from bonjour for more [configuration](https://github.com/watson/bonjour#initializing):

```js
// webpack.config.js
module.exports = {
/* ... */
devServer: {
bonjour: {
name: 'webpack-dev-server',
type: 'https',
subtype: 'webpack',
},
},
};
```

```console
npm run webpack-dev-server -- --config webpack.config.js
```

## What Should Happen

A Zeroconf broadcast should occur, containing data with a type of `https` and a
subtype of `webpack`.