summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 16 insertions, 1 deletions
diff --git a/README b/README
index 9bed714..281956d 100644
--- a/README
+++ b/README
@@ -6,11 +6,26 @@ verification library. lua-scrypt uses the [libscrypt][] library and
provides a simple interface for hashing and verifying passwords.
local scrypt = require "scrypt"
-
+
local hash = scrypt.hash_password("Hello world")
assert(scrypt.verify_password(hash, "Hello world"))
+Installation
+============
+
+To compile lua-scrypt, on platforms with libscrypt 1.21 or later run,
+
+ $ make CFLAGS+=-DTRUST_LIBSCRYPT_SALT_GEN
+
+for platforms with older versions (earlier than 1.21) of libscrypt run,
+
+ $ make
+
+To install lua-scrypt, run,
+
+ $ make install
+
Thanks
======