usage and --help

Author: James Halliday

bin/cmd.js

@@ -8,6 +8,12 @@ var unpack = require('../');
 var format = argv.format || 'pem';
 var encoding = argv.e || argv.encoding || 'hex';
 
+if (argv.h || argv.help) {
+    return fs.createReadStream(__dirname + '/usage.txt')
+        .pipe(process.stdout)
+    ;
+}
+
 var file = process.argv[2] || '-';
 if (file === '-' && format === 'json') {
     var data = '';

bin/usage.txt

@@ -0,0 +1,9 @@
+usage: rsa-unpack {FILE|-} OPTIONS
+
+OPTIONS:
+
+  --format        format to expect FILE to be in.
+                  default: pem or json if FILE ends in .json
+
+  --encoding, -e  encoding to use. default: hex
+

readme.markdown

@@ -47,6 +47,19 @@ The key can be a public or private key.
 
 If the key is invalid, returns undefined.
 
+# command-line usage
+
+```
+usage: rsa-unpack {FILE|-} OPTIONS
+
+OPTIONS:
+
+  --format        format to expect FILE to be in.
+                  default: pem or json if FILE ends in .json
+
+  --encoding, -e  encoding to use. default: hex
+```
+
 # install
 
 With [npm](https://npmjs.org) do: