diff --git a/README.md b/README.md index 6067870..014b72b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ -## GoJava - +## GoJava - Java bindings to Go packages +GoJava uses a [forked version of gomobile](https://github.com/sridharv/gomobile-java) to generate Java bindings to Go packages. +The same set of types are supported. Details on how the binding works can be found [here](https://godoc.org/golang.org/x/mobile/cmd/gobind). + +### Usage + +``` + gojava build [-o ] [, [...]] + + This generates a jar containing Java bindings to the specified Go packages. + + -o string + Path to the generated jar file (default "libgojava.jar") +``` + +You can include the generated jar in your build using the build tool of your choice. +The jar contains a native library (built for the build platform) which is loaded automatically. +Cross platform builds are not currently supported. + +NOTE: This has only been tested on an OSX developer machine and not in production.