summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDaniel Silverstone <dsilvers@digital-scurf.org>2017-06-13 18:58:37 +0100
committerDaniel Silverstone <dsilvers@digital-scurf.org>2017-06-13 18:58:37 +0100
commit9c319bdb4e2614878aa6392bee788cf597591c1d (patch)
tree6ed5df7009ab8edeb067cf86d4fbbf74cf9a3d44 /README
parent55e859083e94dc052791bb7329af2149eded470c (diff)
parent9271157304dbd707f87343df0106c3465b50d6a1 (diff)
downloadlua-scrypt-git-9c319bdb4e2614878aa6392bee788cf597591c1d.tar.gz
Merge remote-tracking branch 'ripsum/richardipsum/no-saltgen-override-v3'
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
======