README.md in inspec_tools-1.8.3 vs README.md in inspec_tools-2.0.0
- old
+ new
@@ -1,8 +1,9 @@
# InspecTools
-
+
+
InspecTools supplies several CLI tools to convert to and from InSpec format.
The inspec_tools support the following modules:
@@ -138,17 +139,20 @@
```
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
+ -j --inspec-json <inspec-json> : path to InSpec results JSON
+ -o --output <output-json> : path to summary JSON
+ -c --cli, --no-cli : print summary to STDOUT
+ -V --verbose, --no-verbose : print verbose an debug output
+ -f --json-full, --no-json-full : print the summary STDOUT as JSON
+ -k --json-counts, --no-json_cou : print the reslut status to STDOUT as JSON
Examples:
- inspec_tools summary -j examples/sample_json/rhel-simp.json -o summary.json -c
+ inspec_tools summary -j examples/sample_json/rhel-simp.json -f -o summary.json -c
```
## xccdf2inspec
xccdf2inspec translates an xccdf file to an InSpec profile in one or many files
@@ -295,9 +299,19 @@
View our wiki pages on [expected](https://github.com/mitre/inspec_tools/wiki/Expected-Input) input and [expected output](https://github.com/mitre/inspec_tools/wiki/Expected-Output) for more information about what is currently supported input and expected output.
# `inspec_tools` Development
View our [wiki page](https://github.com/mitre/inspec_tools/wiki/Development) for more information on contributing.
+
+# Publishing a Release
+
+If you are a maintainer, it is very easy to cut a release of this gem:
+
+1. Click on "Releases" and there should be a draft pending.
+2. Make sure the Tag version and Release title match!
+3. Add any additional notes can be added in the Description box.
+4. Click "Publish release".
+5. Release notes will be posted and a new gem will be pushed to Rubygems & Github Packages with the version you specified on step 2.
### NOTICE
© 2018 The MITRE Corporation.