From 707b1eb2993266a587fc7cf2eafb02c52a819284 Mon Sep 17 00:00:00 2001 From: Eric Renfro Date: Wed, 13 May 2015 12:23:45 -0400 Subject: [PATCH] Updated readme to be more complete, and use github style tables --- README.md | 25 ++++++------------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 9b632c1..550d241 100644 --- a/README.md +++ b/README.md @@ -9,24 +9,13 @@ Requirements Attributes ---------- -TODO: List your cookbook attributes here. e.g. #### sudo_rules::default - - - - - - - - - - - - - -
KeyTypeDescriptionDefault
['sudo_rules']['data_bag']StringName of data bag to use for entriessudo_rules
+ +Key | Type | Description | Default +---------------- | ------ | ------------------------------------ | ---------- +`['sudo_rules']` | String | Name of data bag to use for entries. | sudo_rules Usage ----- @@ -79,9 +68,6 @@ Defaults: List of defaults this user has. Contributing ------------ -TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section. - -e.g. 1. Fork the repository on Github 2. Create a named feature branch (like `add_component_x`) 3. Write your change @@ -91,5 +77,6 @@ e.g. License and Authors ------------------- -Authors: TODO: List authors +Authors: Eric Renfro +