formalizing command patterns

Author: Michael Davis

README.md

@@ -2,15 +2,18 @@
 ![npm](https://img.shields.io/npm/v/contentstack-cli-tsgen)
 
 ## Description
-Generate TypeScript typings from Contentstack Content Types. Interfaces and fields are annotated with JSDoc comments.
+This is a plugin for [Contentstack's](https://www.contentstack.com/) CLI.
+This plugin generates TypeScript typings from Content Types. Interfaces and fields are optionally annotated with JSDoc comments.
 
 ## How to install this plugin
 
 ```shell
 $ csdx plugins:install contentstack-cli-tsgen
 ```
 
-## `csdx tsgen`
+## How to use this plugin
+
+`$ csdx tsgen`
 
 generate TypeScript typings from a Stack
 
@@ -25,12 +28,12 @@ OPTIONS
   -p, --prefix=prefix            Interface prefix, e.g. "I"
 
 EXAMPLES
-  $ csdx tsgen -a "delivery-token-alias" -o "contentstack/generated.d.ts"
-  $ csdx tsgen -a "delivery-token-alias" -o "contentstack/generated.d.ts" -p "I"
-  $ csdx tsgen -a "delivery-token-alias" -o "contentstack/generated.d.ts" --no-doc
+  $ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts"
+  $ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" -p "I"
+  $ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --no-doc
 ```
 
-_See code: [src/commands/tsgen.ts](https://github.com/Contentstack-Solutions/contentstack-cli-tsgen/blob/v1.0.5/src/commands/tsgen.ts)_
+_See code: [src/commands/tsgen.ts](https://github.com/Contentstack-Solutions/contentstack-cli-tsgen/blob/v1.0.6/src/commands/tsgen.ts)_
 <!-- commandsstop -->
 
 ## Supported Fields

oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"1.0.4","commands":{"tsgen":{"id":"tsgen","description":"generate TypeScript typings from a Stack","pluginName":"contentstack-cli-tsgen","pluginType":"core","aliases":[],"examples":["$ csdx tsgen -a \"delivery token alias\" -o \"contentstack/generated.d.ts\"","$ csdx tsgen -a \"delivery token alias\" -o \"contentstack/generated.d.ts\" -p \"I\"","$ csdx tsgen -a \"delivery token alias\" -o \"contentstack/generated.d.ts\" --no-doc"],"flags":{"token-alias":{"name":"token-alias","type":"option","char":"a","description":"Delivery token alias","hidden":false,"required":true},"output":{"name":"output","type":"option","char":"o","description":"Full path to output","hidden":false,"required":true},"prefix":{"name":"prefix","type":"option","char":"p","description":"Interface prefix, e.g. \"I\"","hidden":false,"required":false,"default":""},"doc":{"name":"doc","type":"boolean","char":"d","description":"Include documentation comments","allowNo":true}},"args":[]}}}

src/commands/tsgen.ts

@@ -6,9 +6,9 @@ export default class TypeScriptCodeGeneratorCommand extends Command {
   static description = 'generate TypeScript typings from a Stack';
 
   static examples = [
-    '$ csdx tsgen -a "delivery-token-alias" -o "contentstack/generated.d.ts"',
-    '$ csdx tsgen -a "delivery-token-alias" -o "contentstack/generated.d.ts" -p "I"',
-    '$ csdx tsgen -a "delivery-token-alias" -o "contentstack/generated.d.ts" --no-doc',
+    '$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts"',
+    '$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" -p "I"',
+    '$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --no-doc',
   ];
 
   static flags = {