docs: add description to cli --help block

Author: svolkov

README.md

@@ -28,7 +28,7 @@ Usage: swagger-typescript-api [options]
 
 Options:
   -v, --version          output the current version
-  -p, --path <path>      path to swagger scheme
+  -p, --path <path>      path/url to swagger scheme
   -o, --output <output>  output path of typescript api file (default: ".")
   -n, --name <name>      name of output typescript api file (default: "api.ts")
   -h, --help             output usage information

index.js

@@ -13,7 +13,8 @@ const { version } = require('./package.json');
 
 program
   .version(version, '-v, --version', 'output the current version')
-  .requiredOption('-p, --path <path>', 'path to swagger scheme')
+  .description("Generate api via swagger scheme.\nSupports OA 3.0, 2.0, JSON, yaml.")
+  .requiredOption('-p, --path <path>', 'path/url to swagger scheme')
   .option('-o, --output <output>', 'output path of typescript api file', '.')
   .option('-n, --name <name>', 'name of output typescript api file', 'api.ts');
 

package.json

@@ -4,6 +4,7 @@
   "description": "Create typescript api module from swagger schema",
   "scripts": {
     "cli": "node index.js -p ./tests/schemas/v3.0/personal-api-example.json -o ./tests/generated/v3.0/ -n personal-api-example.ts",
+    "cli:help": "node index.js -h",
     "generate": "node tests/generate.js",
     "generate:debug": "node --nolazy --inspect-brk=9229 tests/generate.js",
     "validate": "node tests/validate.js"