From e12a348054da6926925d84fb3df80ac8e827b0bc Mon Sep 17 00:00:00 2001 From: William Petit Date: Tue, 7 Apr 2020 08:47:03 +0200 Subject: [PATCH] Update README --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 717d72d..09e30da 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,32 @@ go install forge.cadoles.com/wpetit/scaffold/cmd/scaffold TODO ``` +## Usage + +``` +NAME: + scaffold - generate/update directory tree from template + +USAGE: + scaffold [global options] command [command options] [arguments...] + +COMMANDS: + from, n generate a new project from a given template url + help, h Shows a list of commands or help for one command + +GLOBAL OPTIONS: + --help, -h show help (default: false) +``` + +### `scaffold from [command options] ` + +``` +OPTIONS: + --directory DIR, -d DIR Set destination to DIR (default: "./") + --manifest FILE, -m FILE The scaffold manifest FILE (default: "scaffold.yml") + --help, -h show help (default: false) +``` + ## Licence GPL-3.0 \ No newline at end of file