Merge pull request #33 from tikui/add-example-for-create

Add Example for create command and add tikui command

README.md

@@ -22,4 +22,4 @@ npm install --global
 
 ## Use
 
-When installed, launch `tikuicli` command and follow help to use the CLI.
+When installed, launch `tikui` command and follow help to use the CLI.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tikui/cli",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Command lines tool for Tikui",
   "main": "index.js",
   "scripts": {
@@ -64,6 +64,7 @@
     "@": "dist"
   },
   "bin": {
-    "tikuicli": "./dist/bin/tikuicli.js"
+    "tikuicli": "./dist/bin/tikuicli.js",
+    "tikui": "./dist/bin/tikuicli.js"
   }
 }

src/bin/tikuicli.ts

@@ -9,7 +9,8 @@ try {
   program
     .command('create <component> [destination]')
     .option('-p, --prefix <name>', 'prefix')
-    .description('create a component')
+    .description('create a component.')
+    .addHelpText('after', '\nExample:\n $ tikui create -p tikui component src/atom')
     .action((component, destination, options) => {
       createComponent(destination, component, options.prefix);
       console.log(`Creating component ${component} to ${path.resolve(destination)}`); // eslint-disable-line no-console
@@ -20,4 +21,3 @@ try {
   console.error(e.message); // eslint-disable-line no-console
   process.exit(1);
 }
-