From cacb0221f1a8d81c73de6cd8d5ec89db52d277d4 Mon Sep 17 00:00:00 2001 From: PhilKunz Date: Sat, 19 Nov 2016 17:48:07 +0100 Subject: [PATCH] IMprove README --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 57e4693..8169ac7 100644 --- a/README.md +++ b/README.md @@ -26,14 +26,18 @@ this plugin tries to establish some logic in which CLI tools work. 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) -* function is the main thing the tool shall do (like commit) -* argument1 and argument2 are arguments -* option1 is a longform option you can add (like --message for message) -* optionValue is the referenced option value (like a commit message) +* `mytool` obviously is the tool (like git) +* `command` is the main thing the tool shall do (like commit) +* `argument1` and argument2 are arguments +* `option1` is a longform option you can add (like --message for 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 import {Smartcli} from "smartcli"