From 4ce6477d1d0899e4b6cc140ab4203f88b789aa75 Mon Sep 17 00:00:00 2001
From: Quentin Madec <qtmadec@gmail.com>
Date: Fri, 29 Aug 2014 11:08:52 +0200
Subject: [PATCH] Add :zip doc in README.md

---
 README.md            | 14 +++++++-------
 providers/zipfile.rb |  2 +-
 resources/zipfile.rb |  2 +-
 3 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 85870d58..5264e541 100644
--- a/README.md
+++ b/README.md
@@ -530,17 +530,17 @@ end
 ```
 
 ### windows_zipfile
-Most version of Windows do not ship with native cli utility for managing compressed files.  This resource provides a pure-ruby implementation for managing zip files. Be sure to use the `not_if` or `only_if` meta parameters to guard the resource for idempotence or action will be taken on the zip file every Chef run.
+Most version of Windows do not ship with native cli utility for managing compressed files.  This resource provides a pure-ruby implementation for managing zip files. Be sure to use the `not_if` or `only_if` meta parameters to guard the resource for idempotence or action will be taken every Chef run.
 
 #### Actions
 - :unzip: unzip a compressed file
-- :zip: zip a single folder (recursively)
+- :zip: zip a directory (recursively)
 
 #### Attribute Parameters
-- path: name attribute. The path where files will be unzipped to.
-- source: The source of the zip file. This can either be a URI or a local path.
-- overwrite: force an overwrite of the files if the already exists.
-- checksum: useful if source is remote, the SHA-256 checksum of the file--if the local file matches the checksum, Chef will not download it
+- path: name attribute. The path where files will be (un)zipped to.
+- source: source of the zip file (either a URI or local path) for :unzip, or directory to be zipped for :zip.
+- overwrite: force an overwrite of the files if they already exist.
+- checksum: for :unzip, useful if source is remote, if the local file matches the SHA-256 checksum, Chef will not download it.
 
 #### Examples
 
@@ -561,7 +561,7 @@ windows_zipfile 'c:/the_codez' do
 end
 ```
 
-Zip a local zipfile
+Create a local zipfile
 ```ruby
 windows_zipfile 'c:/foo/baz/the_codez.zip' do
   source 'c:/the_codez'
diff --git a/providers/zipfile.rb b/providers/zipfile.rb
index d5a9778d..c123442e 100644
--- a/providers/zipfile.rb
+++ b/providers/zipfile.rb
@@ -2,7 +2,7 @@
 # Author:: Doug MacEachern (<dougm@vmware.com>)
 # Author:: Seth Chisamore (<schisamo@opscode.com>)
 # Cookbook Name:: windows
-# Provider:: unzip
+# Provider:: zipfile
 #
 # Copyright:: 2010, VMware, Inc.
 # Copyright:: 2011, Opscode, Inc.
diff --git a/resources/zipfile.rb b/resources/zipfile.rb
index 02658164..a7dd79e8 100644
--- a/resources/zipfile.rb
+++ b/resources/zipfile.rb
@@ -2,7 +2,7 @@
 # Author:: Doug MacEachern (<dougm@vmware.com>)
 # Author:: Seth Chisamore (<schisamo@opscode.com>)
 # Cookbook Name:: windows
-# Resource:: unzip
+# Resource:: zipfile
 #
 # Copyright:: 2010, VMware, Inc.
 # Copyright:: 2011, Opscode, Inc.