From e4a8f6245b838b3a0774abb9e9ba151d151c48aa Mon Sep 17 00:00:00 2001
From: Chris Conlon <chris@wolfssl.com>
Date: Mon, 6 Jul 2015 10:29:19 -0600
Subject: [PATCH] Add README for wolfcrypt-jni

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..664f2f5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+
+## wolfCrypt JNI
+
+This package provides a Java, JNI-based interface to the native wolfCrypt
+FIPS API.
+
+### Compiling
+---------
+
+To compile the wolfcrypt-jni wrapper:
+
+1) Compile and install a wolfSSL FIPS release (wolfssl-x.x.x-commercial-fips):
+```
+$ cd wolfssl-x.x.x-commercial-fips
+$ ./configure --enable-fips --enable-keygen
+$ make check
+$ sudo make install
+```
+
+2) Compile the native wolfCrypt JNI object files:
+```
+$ cd wolfcrypt-jni
+$ make
+```
+
+3) Compile the wolfCrypt JNI Java sources files, from the wolfcrypt-jni
+   directory:
+```
+$ ant
+$ ant test
+```