docs: add note about dev dependency

Planable · Mar 26, 2022 · 9af20be · 9af20be
1 parent a9a6fd0
commit 9af20be
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -19,3 +19,9 @@ This is why `npx why` exists!
 npx why --init # will create a package-why.json file where you can write docs for your scripts
 npx why test # will display docs for 'npm run test' command
 ```
+
+For better experience install the package as devDependencies:
+
+```bash
+npm install why --save-dev
+```
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "why",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "A tool to document your package.json scripts",
   "main": "src/index.js",
   "bin": "src/index.js",