From 18b639c9997a6f1033a9f18c11d291d2504323ed Mon Sep 17 00:00:00 2001 From: Christoph Hartmann Date: Thu, 27 Oct 2016 21:55:34 +0200 Subject: [PATCH] update readme Signed-off-by: Christoph Hartmann --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 530d9042..98bb7cce 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ # audit cookbook [![Cookbook Version](http://img.shields.io/cookbook/v/audit.svg)][cookbook] [![Build Status](http://img.shields.io/travis/chef-cookbooks/audit.svg)][travis] +The `audit` cookbook allows you to run InSpec profiles as part of a Chef Client run. It downloads configured profiles from various sources like Chef Compliance, Chef Supermarket or Git and reports audit runs to Chef Compliance or Chef Visibility. + +Version 2.0 of the audit cookbook is based on an idea from [Michael Hedgpeth](https://github.com/chef-cookbooks/audit/issues/70). Under the hood it uses [Chef handler](https://docs.chef.io/handlers.html) instead of Chef resources now. + NOTE: The current readme refers to unreleased audit cookbook 2.0. Documentation for 1.x is available (here)[https://github.com/chef-cookbooks/audit/blob/v1.1.0/README.md] ## Requirements ### Chef -- Chef Client >=12.5.1 -The `audit` cookbook allows you to run Chef Compliance profiles as part of a Chef Client run. It downloads configured profiles from Chef Compliance and reports audit runs to Chef Compliance. +- Chef Client >=12.5.1 ### Chef Compliance and InSpec