README.md in chef-sugar-3.6.0 vs README.md in chef-sugar-4.0.0

@@ -1,19 +1,30 @@
-Chef Sugar
-==========
-[![Gem Version](http://img.shields.io/gem/v/chef-sugar.svg?style=flat-square)][gem]
-[![Build Status](http://img.shields.io/travis/sethvargo/chef-sugar.svg?style=flat-square)][travis]
+# Chef Sugar
 
-[gem]: https://rubygems.org/gems/chef-sugar
-[travis]: http://travis-ci.org/sethvargo/chef-sugar
+[![Gem Version](http://img.shields.io/gem/v/chef-sugar.svg?style=flat-square)][gem] [![Build Status](http://img.shields.io/travis/sethvargo/chef-sugar.svg?style=flat-square)][travis]
 
 Chef Sugar is a Gem & Chef Recipe that includes series of helpful syntactic sugars on top of the Chef core and other resources to make a cleaner, more lean recipe DSL, enforce DRY principles, and make writing Chef recipes an awesome and fun experience!
 
-Installation
-------------
-If you want to develop/hack on chef-sugar, please see the Contributing.md.
+## Requirements
 
+### Platforms
+
+- any platform
+
+
+### Chef
+
+- Chef 12.10+
+
+### Cookbooks
+
+- none
+
+## Installation
+
+If you want to develop/hack on chef-sugar, please see the CONTRIBUTING.md.
+
 If you are using Berkshelf, add `chef-sugar` to your `Berksfile`:
 
 ```ruby
 cookbook 'chef-sugar'
 ```
@@ -22,24 +33,18 @@
 
 ```ruby
 knife cookbook site install chef-sugar
 ```
 
+## Usage
 
-Usage
------
-In order to use Chef Sugar in your Chef Recipes, you'll first need to include it:
+Simply depend on this cookbook in the metadata of your cookbook and the gem will be installed and required..
 
-```ruby
-include_recipe 'chef-sugar::default'
-```
-
-Alternatively you can put it in a base role or recipe and it will be included subsequently.
-
 Requiring the Chef Sugar Gem will automatically extend the Recipe DSL, `Chef::Resource`, and `Chef::Provider` with helpful convenience methods.
 
 ### Module Method
+
 If you are working outside of the Recipe DSL, you can use the module methods instead of the Recipe DSL. In general, the module methods have the same name as their Recipe-DSL counterparts, but require the node object as a parameter. For example:
 
 In a Recipe:
 
 ```ruby
@@ -65,16 +70,16 @@
 def only_on_windows(&block)
   yield if windows?(@node)
 end
 ```
 
+## API
 
-API
----
 **Note:** For the most extensive API documentation, please see the YARD documentation.
 
 ### Architecture
+
 **Note:** Some of the architecture commands begin with an underscore (`_`) because Ruby does not permit methods to start with a numeric.
 
 - `_64_bit?`
 - `_32_bit?`
 - `intel?`
@@ -82,18 +87,20 @@
 - `ppc64?`
 - `ppc64le?`
 - `powerpc?`
 
 #### Examples
+
 ```ruby
 execute 'build[my binary]' do
   command '...'
   not_if  { _64_bit? }
 end
 ```
 
 ### Cloud
+
 - `azure?`
 - `cloud?`
 - `digitalocean?`
 - `ec2?`
 - `eucalyptus?`
@@ -103,20 +110,22 @@
 - `cloudstack?`
 - `rackspace?`
 - `softlayer?`
 
 #### Examples
+
 ```ruby
 template '/tmp/config' do
   variables(
     # See also: best_ip_for
     ipaddress: cloud? ? node['local_ipv4'] : node['public_ipv4']
   )
 end
 ```
 
 ### Core Extensions
+
 **Note:** Core extensions are **not** included by default. You must require the `chef/sugar/core_extensions` module manually to gain access to these APIs:
 
 ```ruby
 require 'chef/sugar/core_extensions'
 ```
@@ -125,10 +134,11 @@
 - `String#satisfied_by?`
 - `Array#satisfied_by?`
 - `Object#blank?`
 
 #### Examples
+
 ```ruby
 # Checking version constraints
 '1.0.0'.satisfies?('~> 1.0') #=> true
 '~> 1.0'.satisfied_by?('1.0') #=> true
 ```
@@ -138,15 +148,17 @@
 ''.blank? #=> true
 ['hello'].blank? #=> false
 ```
 
 ### Data Bag
+
 - `encrypted_data_bag_item` - a handy DSL method for loading encrypted data bag items the same way you load a regular data bag item; this requires `Chef::Config[:encrypted_data_bag_secret]` is set!
 - `encrypted_data_bag_item_for_environment` - find the encrypted data bag entry for the current node's Chef environment.
 - `data_bag_item_for_environment` - find the data bag entry for the current node's Chef environment.
 
 #### Examples
+
 ```ruby
 encrypted_data_bag_item('accounts', 'hipchat')
 ```
 
 ```ruby
@@ -156,22 +168,25 @@
 ```ruby
 data_bag_item_for_environment('accounts', 'github')
 ```
 
 ### Docker
+
 Chef Sugar looks for hints to see if the node being converged is a Docker container. When [Ohai supports checking other nodes](https://github.com/opscode/ohai/pull/428), Chef Sugar will automatically pick up the information.
 
 - `docker?`
 
 #### Examples
+
 ```ruby
 template '/runme' do
   only_if { docker?(node) }
 end
 ```
 
 ### Attributes
+
 Chef Sugar adds more Chef-like DSL to attribute definitions. Instead of using the Ruby hash syntax, you can define attributes using nested namespaces. This DSL may be more friendly to non-Ruby developers. It can safely be mixed-and-matched with the standard syntax.
 
 ```ruby
 # This is functionally the same as default['apache2']['config']['root'] = '/var/www'
 namespace 'apache2' do
@@ -196,15 +211,17 @@
   end
 end
 ```
 
 ### Constraints
+
 - `constraints` - create a new constraint (or requirement) that can be used to test version validations.
 - `chef_version` - (DSL only) a wrapper for `version(Chef::VERSION)`
 - `version` - create a new version that can be used to test constraint validation.
 
 #### Examples
+
 ```ruby
 # Check if a version is satisfied by a constraint
 version('1.2.3').satisfies?('~> 1.2.0')
 ```
 
@@ -225,18 +242,22 @@
   not_if { chef_version.satisfies?('~> 11.0') } # Ignore Chef 11
 end
 ```
 
 ### Kernel
+
 - `require_chef_gem` - "safely" require a gem. Loading a gem with Chef is sometimes difficult and confusing. The errors that Chef produces are also sometimes not very intuitive. In the event you require a gem to exist on the system, you can use `require_chef_gem`, which will attempt to require the gem and then produce helpful output if the gem is not installed:
 
-        Chef could not load the gem `#{name}'! You may need to install the gem
-        manually with `gem install #{name}', or include a recipe before you can
-        use this resource. Please consult the documentation for this cookbook
-        for proper usage.
+  ```
+    Chef could not load the gem `#{name}'! You may need to install the gem
+    manually with `gem install #{name}', or include a recipe before you can
+    use this resource. Please consult the documentation for this cookbook
+    for proper usage.
+  ```
 
 #### Examples
+
 ```ruby
 # LWRP
 require_chef_gem 'pry'
 ```
 
@@ -249,15 +270,17 @@
   end
 end
 ```
 
 ### Init
+
 - `systemd?` - detect if init system is systemd
 - `upstart?` - detect if init system is upstart
 - `runit?` - detect if init system is runit
 
 #### Examples
+
 ```ruby
 systemd_service 'my-service' do
   description 'My Service'
   install do
     wanted_by 'multi-user.target'
@@ -274,13 +297,15 @@
   only_if { upstart? }
 end
 ```
 
 ### IP
+
 - `best_ip_for` - determine the best IP address for the given "other" node, preferring local IP addresses over public ones.
 
 #### Examples
+
 ```ruby
 redis = search('node', 'role:redis').first
 
 template '/tmp/config' do
   variables(
@@ -296,10 +321,11 @@
 - `deep_fetch` - safely fetch a nested attribute.
 - `deep_fetch!` - fetch a nested attribute, raising a more semantic error if the key does not exist.
 - `in?` - determine if the node is in the given Chef environment.
 
 #### Examples
+
 ```ruby
 credentials = if node.in?('production')
                 Chef::EncryptedDataBag.new('...')
               else
                 data_bag('...')
@@ -309,10 +335,11 @@
 ```ruby
 node.deep_fetch('apache2', 'config', 'root') => node['apache2']['config']['root']
 ```
 
 ### Platform
+
 - `amazon_linux?`
 - `centos?`
 - `linux_mint?`
 - `oracle_linux?`
 - `redhat_enterprise_linux?`
@@ -324,11 +351,11 @@
 - `omnios?`
 - `raspbian?`
 - `nexus?`
 - `ios_xr?`
 
-There are also a series of dynamically defined matchers that map named operating system release versions and comparison operators in the form "#{platform}\_#{operator}\_#{name}?". For example:
+There are also a series of dynamically defined matchers that map named operating system release versions and comparison operators in the form "#{platform}_#{operator}_#{name}?". For example:
 
 - `debian_after_squeeze?`
 - `linuxmint_after_or_at_olivia?`
 - `mac_os_x_lion?`
 - `ubuntu_before_lucid?`
@@ -342,17 +369,19 @@
 require 'chef/sugar'
 puts Chef::Sugar::Platform.instance_methods
 ```
 
 #### Examples
+
 ```ruby
 if ubuntu?
   execute 'apt-get update'
 end
 ```
 
 ### Platform Family
+
 - `arch_linux?`
 - `debian?`
 - `fedora?`
 - `freebsd?`
 - `gentoo?`
@@ -364,30 +393,34 @@
 - `suse?`
 - `windows?`
 - `wrlinux?`
 
 #### Examples
+
 ```ruby
 node['attribute'] = if windows?
                       'C:\Foo\BarDrive'
                     else
                       '/foo/bar_drive'
                     end
 ```
 
 ### Ruby
+
 **Note:** The applies to the Ruby found at `node['languages']['ruby']`.
 
 - `ruby_20?`
 - `ruby_19?`
 
 #### Examples
+
 ```ruby
 log 'This has been known to fail on Ruby 2.0' if ruby_20?
 ```
 
 ### Run Context
+
 - `includes_recipe?` - determines if the current run context includes the recipe
 
 ```ruby
 if includes_recipe?('apache2::default')
   apache_module 'my_module' do
@@ -395,17 +428,19 @@
   end
 end
 ```
 
 ### Shell
+
 - `which`
 - `dev_null`
 - `installed?`
 - `installed_at_version?`
 - `version_for`
 
 #### Examples
+
 ```ruby
 log "Using `mongo` at `#{which('mongo')}`"
 
 if installed?('apt')
   execute 'apt-get update'
@@ -418,40 +453,46 @@
 
 log "Skipping git install, version is at #{version_for('mongo', '-v')}"
 ```
 
 ### Vagrant
+
 - `vagrant?`
 
 #### Examples
+
 ```ruby
 http_request 'http://...' do
   not_if { vagrant? }
 end
 ```
 
 ### Virtualization
+
 - `kvm?`
 - `lxc?`
 - `virtualbox?`
 - `vmware?`
 - `openvz?`
 
 #### Examples
+
 ```ruby
 service 'ntpd' do
   action [:enable, :start]
   not_if { lxc? }
 end
 ```
 
 ### Filters
+
 - `at_compile_time` - accepts a block of resources to run at compile time
 - `before` - insert resource in the collection before the given resource
 - `after` - insert resource in the collection after the given resource
 
 #### Examples
+
 ```ruby
 at_compile_time do
   package 'apache2'
 end
 
@@ -471,13 +512,12 @@
 after 'service[apache2]' do
   log 'I am after the apache 2 service fires!'
 end
 ```
 
+## License & Authors
 
-License & Authors
------------------
 - Author: Seth Vargo ([e-mail])
 
 ```text
 Copyright 2013-2015 Seth Vargo
 
@@ -491,5 +531,8 @@
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 ```
+
+[gem]: https://rubygems.org/gems/chef-sugar
+[travis]: http://travis-ci.org/sethvargo/chef-sugar