Add ldoc based documentation

1 files changed, 22 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..9bed714
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+lua-scrypt
+==========
+
+lua-scrypt is a binding to libscrypt which is a password crypting and
+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"))
+
+Thanks
+======
+
+Originally, [Rob Kendrick][] wrote `lua-scrypt` back when there wasn't a shared
+library for the scrypt algorithm.  The returned values were binary and a bit
+messy, and as such they are not supported by this version of the library.
+
+[libscrypt]: https://github.com/technion/libscrypt
+[Rob Kendrick]: http://www.rjek.com/