Update documentation and README 📖

CoorpAcademy · Oct 17, 2024 · c09357a · c09357a
1 parent 093a7e9
commit c09357a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -38,6 +38,12 @@ Options:
   -d, --default-config, --default      Override update-node configuration
                                        default path                    [boolean]
   -c, --clean                          Run on a clean state            [boolean]
+  -i, --run-npm-install                Run npm install after patching
+                                       package.json (default, disable with
+                                       --no-run-npm-install)
+                                                       [boolean] [default: true]
+  -b, --pre-commit-bump-command        Command to run before to commit (changes
+                                       will be commited)                 [array]
   -p, --pre-clean-command              Run before to clean state         [array]
   -P, --post-clean-command             Run on a clean state              [array]
   -f, --force                          Git Push with force changes

diff --git a/src/index.js b/src/index.js
@@ -130,7 +130,8 @@ const yargs = require('yargs')
     alias: 'c'
   })
   .option('run-npm-install', {
-    describe: 'Command to run before to commit (disable with --no-run-npm-install)',
+    describe:
+      'Run npm install after patching package.json (default, disable with --no-run-npm-install)',
     boolean: true,
     alias: 'i',
     default: true