Update README
This commit is contained in:
parent
90bb429734
commit
e12a348054
26
README.md
26
README.md
|
@ -18,6 +18,32 @@ go install forge.cadoles.com/wpetit/scaffold/cmd/scaffold
|
||||||
TODO
|
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] <URL>`
|
||||||
|
|
||||||
|
```
|
||||||
|
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
|
## Licence
|
||||||
|
|
||||||
GPL-3.0
|
GPL-3.0
|
Loading…
Reference in New Issue