Skip to content

Commit 7ce002d

Browse files
committed
Updating README and help informatin.
1 parent 5ea9422 commit 7ce002d

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,20 @@ CfgCrypt or config crypt is a cli tool to encrypt values in a text configuration
2222

2323
## Usage
2424

25+
To use boolean parameters set -boolvar=true/false
2526
```
2627
cfgcrypt [textfile] ...
27-
textfile Text file to encrypt. (required)
28-
-key string
29-
Base64 encoded encryption key, if not specified one will be generated
30-
-postfix string
31-
Post string denoting end of value to be encrypted (default "}}#")
32-
-prefix string
33-
Prefix string denoting start of value to be encrypted (default "#{{")
34-
-force bool
35-
Overwrites key file if it exists
28+
textfile Text file to encrypt. (required)
29+
-debug bool
30+
Display detailed error messages
31+
-force bool
32+
Overwrite key file if found
33+
-key string
34+
Base64 encoded encryption key, if not specified one will be generated
35+
-postfix string
36+
Post string denoting end of value to be encrypted (default "}}#")
37+
-prefix string
38+
Prefix string denoting start of value to be encrypted (default "#{{")
3639
```
3740

3841
## Example

main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010

1111
func explainUsage(cli *flag.FlagSet) {
1212
fmt.Println("cfgcrypt [textfile] ...")
13-
fmt.Println("\ttextfile\tText file to encrypt. (required)")
13+
fmt.Println(" textfile Text file to encrypt. (required)")
1414
cli.PrintDefaults()
1515
}
1616

0 commit comments

Comments
 (0)