diff --git a/packages/neutrino-middleware-dev-server/README.md b/packages/neutrino-middleware-dev-server/README.md index 447407d..25155bd 100644 --- a/packages/neutrino-middleware-dev-server/README.md +++ b/packages/neutrino-middleware-dev-server/README.md @@ -49,7 +49,7 @@ By default this middleware will start a development server with the hot reload s It is recommended to call this middlware only in development mode when `process.env.NODE_ENV === 'development'`. More imformation about usage of Neutrino middlwares can be found in the [documentation](https://neutrino.js.org/middleware). -## Customization +## Configuration `neutrino-middleware-dev-server` optionally accepts an object with several options to override the default behavior. @@ -58,6 +58,28 @@ It is recommended to call this middlware only in development mode when `process. * `port`: Optional naumber value of the custom port. Default is `5000`. * `open`: Optional boolean value to open the project in the new tab of the default browser. Default is `false`. +## Customization + +`neutrino-middleware-dev-server` creates some conventions to make overriding the configuration easier for the end consumer that setups his project. All parameters are optional and can be configured in the *package.json*: + +```json +{ + ... + "neutrino": { + "use": [...], + "options": { + "server": { + "public": true, + "open": true, + "https": true, + "port": 4000 + } + } + }, + ... +} +``` + ## Contributing This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo