From 8eafa6fabb73b421df939730d6584ef6c485c888 Mon Sep 17 00:00:00 2001
From: Thorsten Eckel <te@znuny.com>
Date: Wed, 8 Apr 2015 14:15:09 +0200
Subject: [PATCH] Added description.

---
 lib/auto_wizzard.rb | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/lib/auto_wizzard.rb b/lib/auto_wizzard.rb
index 7527a9a1a..245b6e802 100644
--- a/lib/auto_wizzard.rb
+++ b/lib/auto_wizzard.rb
@@ -1,5 +1,21 @@
 module AutoWizzard
 
+=begin
+
+creates or updates Users and sets Settings based on the 'auto_wizzard.json' file placed in the root directory.
+
+there is an example file 'contrib/auto_wizzard_example.json'
+
+  AutoWizzard.setup()
+
+returns
+
+  true if a 'auto_wizzard.json' file was found and processed
+
+  nil if no 'auto_wizzard.json' file was found
+
+=end
+
   def self.setup
 
     auto_wizzard_file_name = 'auto_wizzard.json'