Merge pull request #90 from shortdudey123/add_volume_option_doc

Add parameters for volume_option to README
shortdudey123 · Dec 23, 2016 · c56fdda · c56fdda
2 parents b4e5028 + 914ff4f
commit c56fdda
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## Unreleased
 - **[PR #82](https://github.com/shortdudey123/chef-gluster/pull/82)** - Add license and fix readme
 - **[PR #84](https://github.com/shortdudey123/chef-gluster/pull/84)** - Allow disable of server extending support
+- **[PR #90](https://github.com/shortdudey123/chef-gluster/pull/90)** - Add parameters for volume_option to README
 
 ## v5.2.0 (2016-12-09)
 - **[PR #77](https://github.com/shortdudey123/chef-gluster/pull/77)** - Allow use gluster recipe on already existed filesystem

diff --git a/README.md b/README.md
@@ -116,7 +116,9 @@ end
 
 #### Parameters
 
+- `key` - Volume option to change. Required. Derived from after the `/` of resource name if not given.
 - `value` - The value to set for the given option. Required for the set action. Booleans are mapped to `on` or `off`.
+- `volume` - Volume to chnage. Required. Derived from before the `/` of resource name if not given.
 
 ## Usage