Skip to content

Commit

Permalink
Adding examples
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Lhussiez committed Oct 19, 2018
1 parent c11598e commit d4d6dc1
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ projectmpl
- [Usage](#usage)
- [Commands](#commands)
- [Keeping the template](#keeping-the-template)
- [Examples](#examples)
- [Template Creation](#template-creation)
- [The root `.projectmpl.yml` file](#the-root-projectmplyml-file)
- [Variable declaration](#variable-declaration)
Expand Down Expand Up @@ -82,6 +83,17 @@ the template (to play with it, or simply to keep a copy), make sure you pass
the `--template.keep` option. This option pairs well with `--template.output`
which defines where the template should be downloaded/cloned.

## Examples

```sh
$ # Clone the repository and execute the template that is located in _example/license
$ projectmpl git@github.com:Depado/projectmpl.git --template.path _example/license
$ # Clone the template and render it in a specific directory
$ projectmpl git@github.com:Depado/projectmpl.git --template.path _example/cleanarch --template.keep --template.output "template" -o myamazingproject
$ # Reuse the downloaded template and allow final commands
$ projectmpl template/ -c -o myotherproject
```

# Template Creation

## The root `.projectmpl.yml` file
Expand Down

0 comments on commit d4d6dc1

Please sign in to comment.