Skip to content

Commit

Permalink
fix Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kozmod committed Jan 19, 2023
1 parent 05a299f commit f04b3e2
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/kozmod/progen)

Simple projects generator.

___
### Installation

```console
Expand All @@ -17,21 +17,21 @@ go install github.com/kozmod/progen@latest
```console
go build -o progen .
```

___
### About

`progen` use `yml` config file to generate directories, files and execute commands

#### Allowed config file's keys
`progen` use `yml` config file to generate directories, files and execute commands ([actions](#Actions))
___
### Args

| Name | Type | Description |
|:-----|:------:|:------------------------------------------------------------------:|
| f | string | path to config file |
| v | bool | verbose output |
| dr | bool | `dry run` mode <br/>(to verbose output should be combine with`-v`) |
| help | bool | show flags |

#### Action config file's tags
___
### Actions

| Key | Type | Optional | Description |
|:------------------|:-----------------:|:--------:|:---------------------------------------------------------------------------------:|
Expand All @@ -58,8 +58,8 @@ go build -o progen .
✳️ required one of for parent block

**❗Note:** all action execute on declaration order

#### Example
___
### Example

```yaml
## preprocessing of "raw" config use `text/template` of golang's stdlib
Expand Down Expand Up @@ -136,8 +136,8 @@ files:
cmd:
- curl -H PRIVATE-TOKEN:{{.vars.TOKEN}} {{.vars.REPO_1}}/.editorconfig/raw?ref=master -o .editorconfig
```
#### Generate project structure from configuration file
___
### Generate project structure from configuration file
use configuration file with default name (`progen.yaml`)

Expand Down

0 comments on commit f04b3e2

Please sign in to comment.