Add readme

Author: kpy3

README.md

@@ -4,9 +4,31 @@ erlscrypt
 [![Build Status](https://github.com/kpy3/erlscrypt/workflows/Test/badge.svg)](https://github.com/kpy3/erlscrypt/actions?query=branch%3Amaster+workflow%3A"Test") [![Erlang Versions](https://img.shields.io/badge/Supported%20Erlang%2FOTP-21.0%20to%2023.0-blue)](http://www.erlang.org)
 
 
-An OTP application
+An Erlang NIF for Colin Percival's "scrypt" function.
 
-Build
+General information can be found in [these slides (PDF)](http://www.tarsnap.com/scrypt/scrypt-slides.pdf)
+and [Colin Percival's page on scrypt](http://www.tarsnap.com/scrypt.html).
+
+This library uses code from scrypt 1.6.6.
+
+Using the library
 -----
+Add library as dependency in `rebar.config` 
+
+    {deps, [
+        {erlscrypt, "1.0.0"}
+        ...
+    ]}.
+
+Add `erlscrypt` as application dependency
+
+    {application, app,
+         [
+          {applications, [
+                          ...
+                          erlscrypt
+                         ]},
+          ...
+         ]}. 
 
-    $ rebar3 compile
+Use `erlscrypt:scrypt/6` for encrypting data.

c_src/scrypt_nif.c

@@ -78,4 +78,4 @@ static ERL_NIF_TERM scrypt(ErlNifEnv *env, int argc,
 static ErlNifFunc nif_funcs[] = {
     {"scrypt", 6, scrypt, ERL_NIF_DIRTY_JOB_CPU_BOUND}};
 
-ERL_NIF_INIT(scrypt, nif_funcs, NULL, NULL, NULL, NULL);
+ERL_NIF_INIT(erlscrypt, nif_funcs, NULL, NULL, NULL, NULL);

src/scrypt.app.src src/erlscrypt.app.srcsrc/scrypt.app.src renamed to src/erlscrypt.app.src

@@ -1,6 +1,6 @@
-{application, scrypt,
+{application, erlscrypt,
  [{description, "Erlang NIF for scrypt"},
-  {vsn, "0.1.0"},
+  {vsn, "1.0.0"},
   {registered, []},
   {mod, {scrypt, []}},
   {applications,

src/scrypt.erl src/erlscrypt.erlsrc/scrypt.erl renamed to src/erlscrypt.erl

@@ -1,4 +1,4 @@
--module(scrypt).
+-module(erlscrypt).
 -on_load(init/0).
 
 -behaviour(application).