Fix -conf example in README.md

joaquinlpereyra-ml · Cosmin Cojocar · commit a966ff760c3a · 2019-01-22T15:33:45.000+01:00
1. Example config json included a trailing comma, even though as we obviously know this is how things should be, JSON does not agree and the parser fails miserably
2. Flag was incorrectly stated as -config in the README, the correct flag is -conf
3. Example command did not work as did not include final dot to examine the current pkg.
diff --git a/README.md b/README.md
@@ -95,7 +95,7 @@ A number of global settings can be provided in a configuration file as follows:
 {
     "global": {
         "nosec": "enabled",
-        "audit": "enabled",
+        "audit": "enabled"
     }
 }
 ```
@@ -105,7 +105,7 @@ A number of global settings can be provided in a configuration file as follows:
 
 ```bash
 # Run with a global configuration file
-$ goesc -config config.json
+$ goesc -conf config.json .
 ```
 
 ### Excluding files

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ A number of global settings can be provided in a configuration file as follows:`
`95`	`95`	`{`
`96`	`96`	`"global": {`
`97`	`97`	`"nosec": "enabled",`
`98`		`- "audit": "enabled",`
	`98`	`+ "audit": "enabled"`
`99`	`99`	`}`
`100`	`100`	`}`
`101`	`101`	```
`@@ -105,7 +105,7 @@ A number of global settings can be provided in a configuration file as follows:`
`105`	`105`
`106`	`106`	```bash
`107`	`107`	`# Run with a global configuration file`
`108`		`-$ goesc -config config.json`
	`108`	`+$ goesc -conf config.json .`
`109`	`109`	```
`110`	`110`
`111`	`111`	`### Excluding files`