push.rocks/smartcli
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

IMprove README

Browse Source
This commit is contained in:
Philipp Kunz 2016-11-19 17:48:07 +01:00
parent b98b90163d
commit cacb0221f1
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -26,14 +26,18 @@ this plugin tries to establish some logic in which CLI tools work.
take the following commandline input: take the following commandline input:
``` ```
mytool function argument1 argument2 --option1 -o2 option2Value mytool command argument1 argument2 --option1 -o2 option2Value
``` ```
* 'mytool' obviously is the tool (like git) * `mytool` obviously is the tool (like git)
* function is the main thing the tool shall do (like commit) * `command` is the main thing the tool shall do (like commit)
* argument1 and argument2 are arguments * `argument1` and argument2 are arguments
* option1 is a longform option you can add (like --message for message) * `option1` is a longform option you can add (like --message for message)
* optionValue is the referenced option value (like a commit message) * `optionValue` is the referenced option value (like a commit message)
When there is no command and no option specified the standardTask applied.
When there is a option specified but no command, standardTask applies,
except when of the options is -v, --version or --help.
```javascript ```javascript
import {Smartcli} from "smartcli" import {Smartcli} from "smartcli"