diff --git a/README.md b/README.md index 04dc00f3c..078b8d273 100644 --- a/README.md +++ b/README.md @@ -87,12 +87,12 @@ context: cognitoPoolID: xxx modules: - source: "github.com/zthomas/commit0-terraform-basic" - output: "infrastructure" - - source: "github.com/zthomas/react-mui-kit" - output: "web-app" + output: "infrastructure" + - source: "github.com/zthomas/react-mui-kit" + output: "web-app" ``` -## name +## Name Name of your project. This will be used to name the github repos as well as in other parts of the generated code. []() | | @@ -100,7 +100,7 @@ Name of your project. This will be used to name the github repos as well as in o Required | True Type | String -## context +## Context A key value map of global context parameters to use in the templates. []() | | @@ -108,7 +108,7 @@ A key value map of global context parameters to use in the templates. Required | False Type | Map[String] -## modules +## Modules List of modules template modules to import []() | | @@ -116,7 +116,7 @@ List of modules template modules to import Required | True Type | Map[Module] -## source +## Source We are using go-getter to parse the sources, we you can use any URL or file formats that [go-getter](https://github.com/hashicorp/go-getter#url-format) supports. []() | | @@ -124,7 +124,7 @@ We are using go-getter to parse the sources, we you can use any URL or file form Required | True Type | String -## module +## Params Module parameters to use during templating []() | | @@ -132,7 +132,7 @@ Module parameters to use during templating Required | True Type | String -## output +## Output Template output directory that the current module should write to. []() | | @@ -140,7 +140,7 @@ Template output directory that the current module should write to. Required | False Type | String -## output +## Overwrite Whether to overwrite existing files when generating files from templates []() | | @@ -163,7 +163,7 @@ template: output: web-app ``` -## name +## Name Name of your module. This will be used as the default module directory as well as a display name in the prompts. []() | | @@ -171,7 +171,7 @@ Name of your module. This will be used as the default module directory as well a Required | True Type | String -## description +## Description Short description of the module []() | | @@ -186,7 +186,7 @@ Template configurations Required | False Type | Map -## extension +## Extension File extension to signify that a file is a template. If this is defined, non-template files will not be parsed and will be copied over directly. The default value is `.tmplt` []() | | @@ -194,7 +194,7 @@ File extension to signify that a file is a template. If this is defined, non-tem Required | False Type | Map -## delimiters +## Delimiters An pair of delimiters that the template engine should use. The default values are: `{{`, `}}` []() | | @@ -202,7 +202,7 @@ An pair of delimiters that the template engine should use. The default values ar Required | False Type | Map[String] -## output +## Output The default template output directory that you want the template engine to write to. This will be overwritten by the []() | | @@ -233,7 +233,7 @@ The message that will be presented to the user Required | False Type | String -## options +## Options A list of options to select from. If not given, then it will be rendered as a text input prompt. []() | |