Commit 42e8457f authored by Tim Smith's avatar Tim Smith
Browse files

Update installation and requirements in the readme

Signed-off-by: default avatarTim Smith <>
parent 565e9b2d
......@@ -4,6 +4,21 @@
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!
## Requirements
### Platforms
- any platform
### Chef
- Chef 12.10+
### Cookbooks
- none
## Installation
If you want to develop/hack on chef-sugar, please see the
......@@ -22,13 +37,7 @@ knife cookbook site install chef-sugar
## Usage
In order to use Chef Sugar in your Chef Recipes, you'll first need to include it:
include_recipe 'chef-sugar::default'
Alternatively you can put it in a base role or recipe and it will be included subsequently.
Simply depend on this cookbook in the metadata of your cookbook and the gem will be installed and required..
Requiring the Chef Sugar Gem will automatically extend the Recipe DSL, `Chef::Resource`, and `Chef::Provider` with helpful convenience methods.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment