From c1a3c07040310cfcd35b880a05484b4a26d54bc4 Mon Sep 17 00:00:00 2001 From: cemister <90642859+cemister@users.noreply.github.com> Date: Sun, 23 Jul 2023 23:15:51 +0300 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d47fb1d..780f529 100644 --- a/README.md +++ b/README.md @@ -47,11 +47,11 @@ Tip: | in YAML is for multiline text - [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 - [x] Remember custom config directory if specified AND `--remember` is true (by default false) - [x] Additional error handling for new features -- [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. +- [x] YAML variables that can be set using flags ## Install -If you are not planning to contribue OR you don't need the very last releases: +If you are not planning to contribute OR you don't need the very last releases: ### Linux / MacOS @@ -162,13 +162,13 @@ $ go build # Arguments with ? are optional. $ scaffold --name --yaml --configdir? --git? --remember? ``` -scaffolder 1.1.7: +Scaffolder 1.1.7: -- `--variables` - new flag introduced to allow you set yaml varibales which can be used when scaffolding your project +- `--variables` - New flag introduced to allow you set yaml varibales which can be used when scaffolding your project Example: ```bash -$ scaffold --name example --yaml "hello" --variables language:go,type:compiled +$ scaffold --name example --yaml "hello" --variables language:go, type:compiled ``` ```yaml hello: @@ -180,7 +180,7 @@ hello: type := "{type}" func main(){ - fmt.Println("%s is %s", name,type) + fmt.Printf("%s is %s", name,type) } ``` Result @@ -193,12 +193,12 @@ with hello.go having the content ``` package main - import "fmt"" + import "fmt" func main(){ name := "go" type := "compiled" - fmt.Fprintf("%s is %s", name, type) + fmt.Printf("%s is %s", name, type) } ```