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 1, 2022
1 parent ab8b54a commit f295a4e
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,37 @@
#### 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:

```yaml
--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

Expand Down

0 comments on commit f295a4e

Please sign in to comment.