Update readme

Sipkab · Sipkab · commit 884860e403ef · 2020-01-01T16:10:08.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@ secret/**
 /.saker.build.ideconfigs
 /.saker.project.lock
 /.classpath
+/bin/
diff --git a/README.md b/README.md
@@ -1 +1,21 @@
-# saker.java.compiler
+# saker.java.compiler
+
+Incremental Java compiler support for the [saker.build system](https://saker.build). The project contains the implementation of performing incremental Java compilation during builds with the saker.build system. The implementation performs deep analysis of the compiled source files and can perfectly determine the dependencies of each class, therefore providing minimal rebuilds every time.
+
+The build task also support incremental annotation processing, which can also performed concurrently, further reducing build times.
+
+See the [documentation](https://saker.build/saker.java.compiler/doc/) for more information.
+
+## Build instructions
+
+The project uses the [saker.build system](https://saker.build) for building. It requires multiple JDKs to be installed to successfully build the complete project. This ranges from JDK 8-13, but you can also selectively build for a given JDK using the other build tasks in the `saker.build` build script.
+
+Use the following command to build the project:
+
+```
+java -jar path/to/saker.build.jar -bd build -EUsaker.java.jre.install.locations=path/to/jdk8;path/to/jdk9;... compile saker.build
+```
+
+## License
+
+TBD TODO
