lib/dionysus/security/password_salt.rb in dionysus-1.0.1 vs lib/dionysus/security/password_salt.rb in dionysus-1.0.2
- old
+ new
@@ -1,9 +1,16 @@
require 'dionysus'
require 'active_support/secure_random'
##
-# Encapsulates a password salt.
+# Encapsulates a password salt. This is usually not required specifically,
+# instead it's required as a part of the security module:
+#
+# require 'dionysus/security'
+#
+# However, you may require it specifically:
+#
+# require 'dionysus/security/password_salt'
#
# Examples
#
# salt = PasswordSalt.new
# #=> generates random salt of 8 characters