From 7beb6b529818b94bab07a44d56b7b50edd4e396a Mon Sep 17 00:00:00 2001
From: Max Wilhelm <max.wilhelm@wywy.com>
Date: Tue, 22 Dec 2015 13:57:09 +0100
Subject: [PATCH] added class parameters to README

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/README.md b/README.md
index 9dcbe1d..b7bb70d 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,7 @@
 1. [Setup - The basics of getting started with fluentd](#setup)
 1. [Usage](#usage)
   * [Configuration](#configuration)
+    * [Parameters](#parameters)
     * [Source](#source)
     * [Filter](#filter)
     * [Match](#match)
@@ -41,6 +42,44 @@ include '::fluentd'
 
 ### Configuration
 
+#### Parameters
+
+`manage_repo`
+  Include repository to install recent fluentd (td-agent) from
+  **Default:** 'true'
+`package_ensure`
+  Package ensure
+  **Default:** 'installed'
+`package_name`
+  Package name
+  **Default:** 'td-agent'
+`package_install_options`
+  Package install options
+  **Default:** '[]'
+`service_manage`
+  Defines if the service should be managed by puppet
+  **Default:** 'true'
+`service_name`
+  Name of the service
+  **Default:** 'td-agent'
+`service_ensure`
+  Service ensure
+  **Default:** 'running'
+`service_enabled`
+  Defines if the service should be enabled
+  **Default:** 'true'
+`user_manage`
+  Defines if the user should be manage, which will add the user
+  to groups defined in `user_groups`.
+  For example to be able to view the /var/log directory with group adm
+  **Default:** 'true'
+`user_name`
+  **Default:** 'td-agent'
+`user_group`
+  **Default:** 'td-agent'
+`user_groups`
+  **Default:** '["adm"]'
+
 #### Source
 ```puppet
 ::fluentd::source { 'test':