Merge pull request #181 from chef/update-docs

Merged change e2cba636-a73f-406a-b609-ea044778b6d4

From review branch update-docs into master

Signed-off-by: drichter <drichter@chef.io>

bin/inspec

@@ -25,7 +25,7 @@ class InspecCLI < Thor
     option :key_files, type: :array, default: nil,
       desc: 'Login key or certificate file for a remote scan.'
     option :path, type: :string, default: nil,
-      desc: 'Login path to use when connecting to the target.'
+      desc: 'Login path to use when connecting to the target (WinRM).'
     option :sudo, type: :boolean, default: false,
       desc: 'Run scans with sudo. Only activates on Unix and non-root user.'
     option :sudo_password, type: :string, default: nil,

docs/ctl_inspec.rst

@@ -17,14 +17,14 @@ The following options may be used with any of the InSpec CLI subcommands:
 ``--host``
    The remote host to be tested.
 
-``--key``
+``--key-files``
    The login key or certificate file required for remote scanning.
 
 ``--password``
    The login password for remote scanning.
 
 ``--path``
-   The login path used to connect to the target.
+   The login path used to connect to the target for |winrm|.
 
 ``--port``
    The port over which remote scanning will occur.
@@ -192,3 +192,4 @@ Use ``inspec version`` to print the version of the InSpec CLI.
 .. _winrm: https://msdn.microsoft.com/en-us/library/aa384426(v=vs.85).aspx
 .. |docker| replace:: Docker
 .. _docker: https://www.docker.com/
+.. |json| replace:: JSON

docs/readme.rst

@@ -90,7 +90,7 @@ bundle exec bin/inspec exec demo/test/example_spec.rb
 Stability Index
 -----------------------------------------------------
 
-Every available InSpec resource will indiate its stability. As InSpec matures, certain parts are more reliable than others. Brand new features are likely to be redesigned and marked as such.
+Every available InSpec resource will indicate its stability. As InSpec matures, certain parts are more reliable than others. Brand new features are likely to be redesigned and marked as such.
 
 The stability indices are as follows: