Add --help

RyanZim · Nov 1, 2016 · d237cdc · d237cdc
1 parent d160968
commit d237cdc
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -11,7 +11,10 @@ npm install edit-script
 ## Usage
 
 ```
-edit-script <script-name>
+$ edit-script --help
+Edit npm scripts from the command line without worrying about json escaping.
+
+    edit-script <script>
 ```
 
 ## License

diff --git a/cli.js b/cli.js
@@ -6,6 +6,16 @@ var findPkg = require('pkg-up');
 
 var script = process.argv[2];
 
+// help message:
+if (script === '--help') {
+  console.log(
+    `Edit npm scripts from the command line without worrying about json escaping.
+
+    edit-script <script>`
+  );
+  process.exit();
+}
+
 var pkgPath;
 var pkg = {}
 var scripts = {};