diff --git a/readme.md b/README.md similarity index 91% rename from readme.md rename to README.md index 1dbc99a..d698ab8 100644 --- a/readme.md +++ b/README.md @@ -44,6 +44,22 @@ As the final step, start the development server like this: npm run dev ``` +## Debugging + +The package can be used in conjunction with the Node.js inspector like this: + +```json +"scripts": { + "inspect": "node --inspect node_modules/.bin/micro-dev" +} +``` + +As the final step, start the development server like this: + +```bash +yarn run inspect +``` + ## Contributing 1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device