Update README.md

joprice · Jul 13, 2014 · b1be139 · b1be139
1 parent 4f6efb5
commit b1be139
Showing 1 changed file with 20 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,4 +1,23 @@
 sbt-jni
 =======
 
-Sbt plugin for projects with jni sources
+Sbt plugin for projects with jni sources.
+
+```scala
+import com.github.joprice.Jni
+import Jni.Keys._
+
+Jni.settings
+
+// this will be the name that you call `System.loadLibrary` with, prefixed with "lib"
+libraryName := "libMyApp"
+
+gccFlags ++= Seq("-lpthread")
+
+// defaults to gcc
+nativeCompiler := "g++"
+
+jniClasses := Seq(
+  "com.myapp.ClassWithJniCode"
+)
+```