Merge pull request #16 from qs5779/fix_readme

fixed a typo in the readme
thbe · Jan 22, 2018 · de2b895 · de2b895
2 parents 146a1e1 + 6ea18b4
commit de2b895
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ can use:
 
 ```puppet
 class { '::rkhunter':
-  rootEmail => 'john.doe@example.local',
+  root_email => 'john.doe@example.local',
 }
 ```
 
@@ -94,7 +94,15 @@ The following parameters are available in the rkhunter module
 
 #### `root_email`
 
-Set the root email adress that get notifications if events occur.
+Set the root email address that get notifications if events occur.
+
+#### `warning_email`
+
+Set the email address that gets notifications if warnings occur.
+
+#### `enable_warning_email`
+
+Set to true to send emails on warnings (default: false).
 
 #### `remote_syslog`
 Set to true if remote syslog is used

diff --git a/manifests/init.pp b/manifests/init.pp
@@ -10,7 +10,13 @@
 #  icman = boolean, should icman network check be enabled or disabled
 #
 # [*root_email*]
-#   Set the root email adress that get notifications if events occur
+#   Set the root email address that get notifications if events occur
+#
+# [*warning_email*]
+#   Set the email address that gets notifications if warnings occur
+#
+# [*enable_warning_email*]
+#   Set to true to send emails on warnings (default: false)
 #
 # [*remote_syslog*]
 #   Set to true when remote syslog is enabled