Skip to content

Commit

Permalink
Work on README documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ivancorrales committed Mar 4, 2022
1 parent 8a11a0d commit ea49337
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ func main() {
}
}
```

The below screenshot shows an example of how we can use variabls in the name of the folders and the files.

![Templatizer](docs/screenshot.png)

To make a template available for other people that want to use it, we just need to define a file that contains the definition of the variables in the template. We just need to enum the variables as shown in the below example::

```yml
Expand All @@ -70,6 +75,8 @@ variables:
description: Name of the GH organization
```
The attributes `version` and `mode` are ignored in this version of Templatizer, so we could remove them from the configuration.

Regarding the variables, only the attribute `name`. Anyway, the usage of the attributes `description` and `default` will help us to create handier and more useful templates.
Expand Down

0 comments on commit ea49337

Please sign in to comment.