Remove unnecessary interpolation and

update documentation

Signed-off-by: Gavin Didrichsen <[email protected]>

Author: gavindidrichsen

README.md

@@ -4,12 +4,53 @@
 
 ## Maintainers
 
-* The Habitat Maintainers: <[email protected]>
+* The Core Planners: <[email protected]>
 
 ## Type of Package
 
 Binary package
 
-## Usage
+### Use as Dependency
 
-*TODO: Add instructions for usage*
+Binary packages can be set as runtime or build time dependencies. See [Defining your dependencies](https://www.habitat.sh/docs/developing-packages/developing-packages/#sts=Define%20Your%20Dependencies) for more information.
+
+To add core/patch as a dependency, you can add one of the following to your plan file.
+
+##### Buildtime Dependency
+
+> pkg_build_deps=(core/patch)
+
+##### Runtime dependency
+
+> pkg_deps=(core/patch)
+
+### Use as Tool
+
+#### Installation
+
+To install this plan, you should run the following commands to first install, and then link the binaries this plan creates.
+
+``hab pkg install core/patch --binlink``
+
+will add the following binary to the PATH:
+
+* /bin/patch
+
+#### Using an example binary
+
+You can now use the binary as normal.  For example:
+
+``/bin/patch --help`` or ``patch --help``
+
+```bash
+patch --help
+Usage: patch [OPTION]... [ORIGFILE [PATCHFILE]]
+
+Input options:
+
+  -p NUM  --strip=NUM  Strip NUM leading components from file names.
+  -F LINES  --fuzz LINES  Set the fuzz factor to LINES for inexact matching.
+  -l  --ignore-whitespace  Ignore white space changes between patch and input.
+...
+...
+```

attributes.yml

@@ -1 +1,2 @@
+plan_name: 'patch'
 command_relative_path: 'bin/patch'

controls/patch_exists.rb

@@ -17,7 +17,7 @@
   end
 
   command_relative_path = input('command_relative_path', value: 'bin/patch')
-  command_full_path = File.join(plan_installation_directory.stdout.strip, "#{command_relative_path}")
+  command_full_path = File.join(plan_installation_directory.stdout.strip, command_relative_path)
   describe file(command_full_path) do
     it { should exist }
   end

controls/patch_works.rb

@@ -20,7 +20,7 @@
   end
 
   command_relative_path = input('command_relative_path', value: 'bin/patch')
-  command_full_path = File.join(plan_installation_directory.stdout.strip, "#{command_relative_path}")
+  command_full_path = File.join(plan_installation_directory.stdout.strip, command_relative_path)
   plan_pkg_version = plan_installation_directory.stdout.split("/")[5]
   describe command("#{command_full_path} --version") do
     its('exit_status') { should eq 0 }

inspec.yml

@@ -1,9 +1,7 @@
 name: patch
 title: Habitat Core Plan patch
-maintainer: "The Habitat Maintainers <[email protected]>"
+maintainer: "The Core Planners <[email protected]>"
 summary: InSpec controls for testing Habitat Core Plan patch
-copyright: 2019, Chef Software, Inc.
-copyright_email: [email protected]
 version: 0.1.0
 license: Apache-2.0
-inspec_version: '>= 3.0.25'
+inspec_version: '>= 4.18.108'