docs for libscrypt-kdf

Tarsnap · May 1, 2019 · 3887cb0 · 3887cb0
1 parent 139818e
commit 3887cb0
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/BUILDING b/BUILDING
@@ -15,6 +15,15 @@ Official scrypt tarball releases should build and run on any IEEE Std 1003.1
   3. Provides /dev/urandom.
 
 
+libscrypt-kdf
+-------------
+
+To install the development library, run:
+
+    ./configure --enable-libscrypt-kdf
+    make install
+
+
 Platform-specific notes
 -----------------------
 

diff --git a/README.md b/README.md
@@ -113,6 +113,17 @@ int crypto_scrypt(const uint8_t *, size_t, const uint8_t *, size_t, uint64_t,
     uint32_t, uint32_t, uint8_t *, size_t);
 ```
 
+The same function is provided in the optional `libscrypt-kdf` library; there
+is a sample of using it in `tests/libscrypt-kdf`.  If you installed the
+library, you can compile that file and run the binary:
+
+```
+$ cd tests/libscrypt-kdf/
+$ c99 sample-libscrypt-kdf.c -lscrypt-kdf
+$ ./a.out
+crypto_scrypt(): success
+```
+
 
 Building
 --------