Skip to content

Commit e26f47d

Browse files
author
Heiko Alexander Weber
committed
fixes and updates to README.md
1 parent 5f38674 commit e26f47d

2 files changed

Lines changed: 15 additions & 13 deletions

File tree

LICENSE

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2014 BoltDB
4-
53
Permission is hereby granted, free of charge, to any person obtaining a copy
64
of this software and associated documentation files (the "Software"), to deal
75
in the Software without restriction, including without limitation the rights
@@ -18,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1816
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1917
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2018
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
19+
SOFTWARE.

docs/README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,18 @@ Repository root
3434
│ └── template-a.tpl
3535
├── src
3636
│ └── *
37-
── docs
37+
── docs
3838
└── *
39+
└── ...
3940
```
4041

41-
`complate` writes the generated message to the stdout pipe.\
42+
This way, the `complate` program is redistributed via the GIT repository. If that's not what you want, simply keep the binary in your machine. As long as the configuration file version number fits your installed program major version you're good to go.
4243
Expecting the recommended folder structure, you should be able to simply run `./.complate/complate print | git commit -F -` in order to create a new standardized commit.
4344

4445
## General overview
4546

46-
The template itself can be declared as string inside the configuration file or as a reference to a file that contains the template. The template string can contain variables in handlebars syntax ( `{{ variable}}` ). All distinct variables must have a representation in the according section that then also defines on how to find the value for this variable.
47+
The template itself can be declared as string inside the configuration file or as a reference to a file that contains the template. The template string can contain variables in handlebars syntax ( `{{ variable}}` ). All distinct variables must have a representation in the according section that then also defines on how to find the value for this variable.\
48+
Pro tip: Variables are prompted in alphabetical order. Prefix you variable with `a`, `b`, `c` and such to generate a custom order.
4749

4850
## Technical documentation
4951

@@ -66,7 +68,7 @@ Either one of the `backend+` flags (or both) MUST be enabled for `complate` to w
6668

6769
|Name|Short|Long|Description|
6870
|-- |-- |-- |-- |
69-
|Experimental|-e|--experimental|Activates experimental features that are not stable yet. All features that are marked as experimental are not referenced when keeping backwards compatibility inside one major version.|
71+
|Experimental|-e|--experimental|Activates experimental features that are not stable yet. All features that are marked as experimental are ignored when keeping backwards compatibility inside one major version.|
7072

7173
### Commands
7274

@@ -77,11 +79,12 @@ Either one of the `backend+` flags (or both) MUST be enabled for `complate` to w
7779
|print|Prompts for the template, prompts for variable values and prints the data to `STDOUT`|stable|
7880

7981
### `print` command flags
80-
|Name|Short|Long|Description|Status|
81-
|-- |-- |-- |-- |-- |
82-
|Config file path|-c|--config|The path to the configuration file that shall be used. This path can be relative or absolute. The default path is `./complate/config.yml`.|stable|
83-
|Shell trust||--shell-trust|Enables the shell value provider for replacing template placeholders. Due to the potential security risk with this option, it is disabled by default. Possible values for this option are `none` (default), `prompt` and `ultimate`|stable|
84-
|Backend|-b|--backend|Defines the backend for the user interaction.|`CLI` is stable. `UI` is experimental (feature = "backend+ui").|
82+
83+
|Name|Short|Long|Description|Remark|Status|
84+
|-- |-- |-- |-- |-- |--|
85+
|Config via file path|-c|--config|The path to the configuration file that shall be used. This path can be relative or absolute. The default path is `./.complate/config.yml`.|Can not be used in conjunction with the `pipe` argument.|stable|
86+
|Shell trust||--shell-trust|Enables the shell value provider for replacing template placeholders. Due to the potential security risk with this option, it is disabled by default. Possible values for this option are `none` (default), `prompt` and `ultimate`||stable|
87+
|Backend|-b|--backend|Defines the backend for the user interaction.||`CLI` is stable. `UI` is experimental (feature = "backend+ui").
8588

8689
### Configuration file
8790

@@ -91,6 +94,7 @@ version: 0.6
9194
templates:
9295
default:
9396
content:
97+
file: ./.complate/templates/template-a.tpl
9498
inline: |-
9599
{{ a.summary }} | {{ e.version }}
96100
Components: [{{ f.components }}]
@@ -125,7 +129,7 @@ templates:
125129
- misc
126130
127131
```
128-
This project also uses complate templates that can be found in `./complate/config.yml`.
132+
This project also uses complate. The templates that can be found in `./complate/config.yml`.
129133

130134
#### Value providers
131135

0 commit comments

Comments
 (0)