diff --git a/README.md b/README.md index e124eb0..6a7fadc 100644 --- a/README.md +++ b/README.md @@ -21,15 +21,14 @@ #### Brew tap #### From source code -## Usage - +## Usage: Consuming templates ### Generate params file To create a repository from a template we need to pass an input file with the required variables. Instead of creating this file by hand we can take advantage of the following command ```bash -templatizer from github.com/ivancorrales/seed +templatizer setup --from github.com/ivancorrales/seed ``` Additionally we can pass the following flags: @@ -37,8 +36,22 @@ Additionally we can pass the following flags: --username: Github|gitlab user handle --password: The password for the username ``` -### +### Create repository from template + +```bash +templatizer create --from github.com/ivancorrales/seed +``` + +By default, a named file `templatize-params.yml` will be used. If this file +doesn't exist we will be required to pass the input file with flag `--params` + +```bash +templatizer create --from github.com/ivancorrales/seed --param customize-template.yml +``` + +## Usage: Creating a template +By default the templatizer tool will inspect all the files in the repository template and It will create a named file `templatizer-params.yml` with the variables to be populated. Additionally we could ## Contributing