improve README

This commit is contained in:
Philipp Kunz 2016-11-19 17:48:56 +01:00
parent cacb0221f1
commit 00f5539e6b

View File

@ -31,7 +31,7 @@ mytool command argument1 argument2 --option1 -o2 option2Value
* `mytool` obviously is the tool (like git) * `mytool` obviously is the tool (like git)
* `command` 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)