Skip to content

Commit c1a3c07

Browse files
authored
Update README.md
1 parent 30a15d8 commit c1a3c07

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ Tip: | in YAML is for multiline text
4747
- [x] `--configdir` flag to let the user specify path to custom config folder. Fallback to default path if empty, also let user get the config from current working directory
4848
- [x] Remember custom config directory if specified AND `--remember` is true (by default false)
4949
- [x] Additional error handling for new features
50-
- [x] YAML variables that can be set using a flag. $MY_VAR: Test, a: {MY_VAR}. Parse and replace {MY_VAR} with the actual value.
50+
- [x] YAML variables that can be set using flags
5151

5252
## Install
5353

54-
If you are not planning to contribue OR you don't need the very last releases:
54+
If you are not planning to contribute OR you don't need the very last releases:
5555

5656
### Linux / MacOS
5757

@@ -162,13 +162,13 @@ $ go build
162162
# Arguments with ? are optional.
163163
$ scaffold --name <project name> --yaml <config name> --configdir? <path to custom folder if exists> --git? <true/false> --remember? <true/false>
164164
```
165-
scaffolder 1.1.7:
165+
Scaffolder 1.1.7:
166166

167-
- `--variables` - new flag introduced to allow you set yaml varibales which can be used when scaffolding your project
167+
- `--variables` - New flag introduced to allow you set yaml varibales which can be used when scaffolding your project
168168

169169
Example:
170170
```bash
171-
$ scaffold --name example --yaml "hello" --variables language:go,type:compiled
171+
$ scaffold --name example --yaml "hello" --variables language:go, type:compiled
172172
```
173173
```yaml
174174
hello:
@@ -180,7 +180,7 @@ hello:
180180
type := "{type}"
181181

182182
func main(){
183-
fmt.Println("%s is %s", name,type)
183+
fmt.Printf("%s is %s", name,type)
184184
}
185185
```
186186
Result
@@ -193,12 +193,12 @@ with hello.go having the content
193193
```
194194
package main
195195
196-
import "fmt""
196+
import "fmt"
197197
198198
func main(){
199199
name := "go"
200200
type := "compiled"
201-
fmt.Fprintf("%s is %s", name, type)
201+
fmt.Printf("%s is %s", name, type)
202202
}
203203
```
204204

0 commit comments

Comments
 (0)