[Update] README.md

ph1p · Dec 1, 2018 · 2c13bf9 · 2c13bf9
1 parent 07cc2fa
commit 2c13bf9
Showing 1 changed file with 17 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -14,17 +14,27 @@ yarn i vuepress-jsdoc -g
 
 ```bash
 # search code in src and move it to code (./documentation/code) in your vuepress folder (./documentation)
-vuepress-jsdoc --source=./src --dist=./documentation --folder=code --title=API
+vuepress-jsdoc --source ./src --dist ./documentation --folder code --title API
 ```
 
+### Commands
+
+If no command passed it will run `generate` as default
+
+| Name     | Alias  | Description                                                                                             |
+| -------- | ------ | ------------------------------------------------------------------------------------------------------- |
+| generate | gen, g | search code in src and move it to code (./documentation/code) in your vuepress folder (./documentation) |
+
 ### Options
 
-| name      | default         | description                                                  |
-| --------- | --------------- | ------------------------------------------------------------ |
-| --source= | ./src           | Source folder with .js or .ts files                          |
-| --dist=   | ./documentation | Destination folder                                           |
-| --folder= | ./code          | Folder inside destination folder. Gets overwritten everytime |
-| --title=  | API             | Title of your documentation                                  |
+| Name      | Alias | Default         | Description                                                  |
+| --------  | ----- | --------------- | ------------------------------------------------------------ |
+| --source  | -s    | ./src           | Source folder with .js or .ts files                          |
+| --dist    | -d    | ./documentation | Destination folder                                           |
+| --folder  | -f    | ./code          | Folder inside destination folder. Gets overwritten everytime |
+| --title   | -t    | API             | Title of your documentation                                  |
+| --help    | -h    |                 | Show help                                                    |
+| --version | -v    |                 | Show current version                                         |
 
 ### config.js