From d4d6dc11a9e7f7232188bba6cae1d5f19cde25ad Mon Sep 17 00:00:00 2001 From: Paul Lhussiez Date: Fri, 19 Oct 2018 17:48:05 +0200 Subject: [PATCH] Adding examples --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 1519a1c..05c032d 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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