README.md in chef-sugar-1.3.0 vs README.md in chef-sugar-2.0.0

- old
+ new

@@ -40,11 +40,11 @@ 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 convienence methods. +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: @@ -179,11 +179,11 @@ end end ``` ### Constraints -- `constaints` - create a new contraint (or requirement) that can be used to test version validations. +- `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 @@ -208,11 +208,11 @@ 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 wil attempt to require the gem and then produce helpful output if the gem is not installed: +- `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. @@ -318,10 +318,10 @@ '/foo/bar_drive' end ``` ### Ruby -**Note:** The applies to the the Ruby found at `node['languages']['ruby']`. +**Note:** The applies to the Ruby found at `node['languages']['ruby']`. - `ruby_20?` - `ruby_19?` #### Examples