introduce class parameters to make the interface nicer

1 files changed, 4 insertions, 0 deletions

diff --git a/README b/README
index 94571ec..777aae7 100644
--- a/README
+++ b/README
@@ -16,6 +16,10 @@ Dependencies
 Configuration
 =============
 
+You can set the following parameters for the loginrecords class.
+If you just include the class loginrecords this will disable all
+loginlogs.
+
 $disable_btmp, $disable_utmp, $disable_wtmp
 -------------------------------------------