Improve the cookbook description and readme

README.md

@@ -3,12 +3,12 @@
 [![Cookbook Version](https://img.shields.io/cookbook/v/mondoo.svg)](https://supermarket.chef.io/cookbooks/mondoo)
 [![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
 
-This cookbook installs the Mondoo `cnquery` and `cnspec` on Linux servers.
+This cookbook installs Mondoo `cnquery` and `cnspec` on Linux servers for infrastructure security, compliance, and asset intelligence.
 
-It does:
+The `default` cookbook recipe:
 
 * Installs the signed `mondoo` package
-* Login `cnquery` and `cnspec` with Mondoo Platform
+* Logs in `cnquery` and `cnspec` with Mondoo Platform
 * Enables the `cnspec` systemd service
 
 ## Requirements
@@ -39,25 +39,28 @@ It does:
 
 ## Run Mondoo Cookbook with chef-run
 
-See [examples] for how use this cookbook with `chef-run`
+See the `examples` directory for examples of using this cookbook with `chef-run`.
 
 ## Testing
 
 Ensure docker and vagrant are installed and run:
-```
+
+```bash
 MONDOO_TOKEN=ey...Bp KITCHEN_LOCAL_YAML=kitchen.dokken.yml kitchen test
 ```
+
 (or add MONDOO_API_PROXY to the list of variables to test the setting/using of that variable)
 
 You can "enter" the resulting environment used for the test by changing the 'test' kitchen command to 'login'.
 
-You can reduce the number of environments tested (to speed local testing up) by commenting out unneccessary entries from kitchen.dokken.yml.
+You can reduce the number of environments tested (to speed up local testing) by commenting out unnecessary entries from kitchen.dokken.yml.
 
 ## Release
 
-This repo includes a GitHub action "Supermarket Release", which can be manually triggered to perform a release. Before running this workflow make sure to do the following:
-    - Update the metadata.rb file with the new version.
-    - Update the CHANGELOG.md file to document the new release.
+This repo includes a GitHub action "Supermarket Release", which you can manually trigger to perform a release. Before running this workflow make sure to:
+
+- Update the metadata.rb file with the new version.
+- Update the CHANGELOG.md file to document the new release.
 
 ## Author
 

examples/run/recipes/default.rb

@@ -1,4 +1,4 @@
-# This is really mitigating a bug in Chef. The `package` resoruce fails on a
+# This is really mitigating a bug in Chef. The `package` resource fails on a
 # fresh amazonlinux instance because Chef is not using Utf-8 properly
 # This ensures all exec's by Chef use utf8 as locale
 ENV['LANG'] = 'en_US.utf-8'

metadata.rb

@@ -2,7 +2,7 @@
 maintainer 'Mondoo, Inc'
 maintainer_email '[email protected]'
 license 'Apache-2.0'
-description 'Installs and configures Mondoo Client'
+description 'Installs and configures Mondoo package for infrastructure security, compliance, and asset intelligence'
 version '0.6.0'
 chef_version '>= 14'
 source_url 'https://github.com/mondoohq/chef-mondoo'