diff --git a/README.md b/README.md index 32aac9b87d..b9f4abda75 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,36 @@ Seamless Java in JavaScript applications that tightly optimizes with [Closure Compiler](https://github.com/google/closure-compiler) + +--- + +This is Vertispan LLC's fork of J2CL, which includes a few changes from Google's +original repository including + +* Create Maven pom.xml files to use and distribute J2CL without using Bazel. +* Make some internal APIs public, to more easily build a Maven plugin with the + same flexibility as the Bazel rules. +* Allow more than one J2CL test suite to be built in a single compile. +* Modify Bazel wiring to allow GWT 2's GWTTestCase to be usable outside J2CL + itself. +* Modify Bazel wiring to build Javadocs + +As these changes alter J2CL's own public API, we are currently versioning releases +and snapshots as 0.x.y- releases, to indicate first that this has not yet +reached a 1.0 build, second that each time the `x` increments some API has likely +changed and downstream users should pay attention to what might have been modified, +and third to point at the upstream `` commit sha from the https://github.com/google/j2cl +repository to see where our own changes were applied. The `y` exists only to make +it clear what order the releases were in - two release with different `y` versions +could be packaging changes (if the commit hash is the same) or could be +api-compatible with each other but still worth an update. + +The release process is to rebase this set of commits, then update the version in +the poms appropriately. When a release is pushed to Maven central, a tag will +be pushed to our git repository with a matching version. Snapshot builds on the +`rebased_master` branch will use `-SNAPSHOT` instead of a commit hash, and will be +force pushed as the commits are rebased and updated. + --- J2CL is a powerful, simple and lightweight transpiler from Java to Closure style JavaScript.