README.md in inspec_tools-1.4.0 vs README.md in inspec_tools-1.4.1

- old
+ new

@@ -99,12 +99,13 @@ inspec_tools compliance -j examples/sample_json/rhel-simp.json -i '{compliance.min: 80, failed.critical.max: 0, failed.high.max: 0}' inspec_tools compliance -j examples/sample_json/rhel-simp.json -f examples/sample_yaml/threshold.yaml ``` -##### Possible In-line and yaml file threshold definition styles: +### YAML file or In-line threshold definition styles: +#### File Examples ``` failed: critical: max: 0 high: @@ -112,21 +113,22 @@ compliance: min: 81 ``` ``` -{compliance: {min: 80}, failed: {critical: {max: 0}, high: {max: 0}}} +compliance.min: 81 +failed.critical.max: 1 +failed.high.max: 1 ``` +#### In-Line Exmamples ``` -{compliance.min: 81, failed.critical.max: 10, failed.high.max: 0} +{compliance: {min: 90}, failed: {critical: {max: 0}, high: {max: 0}}} ``` ``` -compliance.min: 81 -failed.critical.max: 10 -failed.high.max: 1 +{compliance.min: 81, failed.critical.max: 0, failed.high.max: 0} ``` ## summary summary parses an inspec results json to create a summary json @@ -135,14 +137,15 @@ USAGE: inspec_tools summary [OPTIONS] -j <inspec-json> -o <summary-csv> FLAGS: -j --inspec-json <inspec-json> : path to InSpec results Json -o --output <output-json> : path to summary json + -c --cli <output-cli> : print summary to stdout Examples: - inspec_tools summary -j examples/sample_json/rhel-simp.json -o summary.json + inspec_tools summary -j examples/sample_json/rhel-simp.json -o summary.json -c ``` ## xccdf2inspec xccdf2inspec translates an xccdf file to an InSpec profile in one or many files @@ -298,10 +301,10 @@ © 2018 The MITRE Corporation. Approved for Public Release; Distribution Unlimited. Case Number 18-3678. -## NOTICE +### NOTICE MITRE hereby grants express written permission to use, reproduce, distribute, modify, and otherwise leverage this software to the extent permitted by the licensed terms provided in the LICENSE.md file included with this project. ### NOTICE