Update README.md with release history and instructions on how to migrate to 3.x

Author: eyalroth

README.md

@@ -4,13 +4,12 @@ gradle-scoverage
 ================
 A plugin to enable the use of Scoverage in a gradle Scala project.
 
-Getting started
----------------
+Usage
+-----
 
-http://plugins.gradle.org/plugin/org.scoverage
+You can find instructions on how to apply the plugin at:  http://plugins.gradle.org/plugin/org.scoverage
 
-Available tasks
----------------
+### Available tasks
 
 1. `reportScoverage`: Produces XML and HTML reports for analysing test code coverage.
 
@@ -29,8 +28,7 @@ Available tasks
     `gradle checkScoverage` will automatically invoke `reportScoverage` but it won't generate aggregated reports.
     In order to check coverage of aggregated reports one should use `gradle checkScoverage aggregateScoverage`.
 
-Configuration
--------------
+### Configuration
 
 The plugin exposes multiple options that can be configured by setting them in an `scoverage` block within the project's
 build script. These options are as follows:
@@ -58,13 +56,58 @@ required for the validation to pass (otherwise `checkScoverage` will fail the bu
 `checkScoverage` task. For more information on the different types, please refer to the documentation of the scalac
 plugin (https://github.com/scoverage/scalac-scoverage-plugin).
 
-Run without normal compilation
-------------------------------
+### Run without normal compilation
 
 By default, running any of the plugin tasks will compile the code both using "normal" compilation (`compileScala`)
 and using the scoverage scalac plugin (`compileScoverageScala`).
 
 In cases where you only wish to generate reports / validate coverage, but are not interested in publishing the code,
 it is possible to only compile the code with the scoverage scalac plugin, thus reducing build times significantly.
 In order to do so, simply add the arguments `-x compileScala` to the gradle execution.
-For example: `gradle reportScoverage -x compileScala`.
+For example: `gradle reportScoverage -x compileScala`.
+
+Migration to 3.x
+----------------
+
+* No more `testScoverage` task; instead, `test` will run coverage whenever the build is invoked with any of the scoverage tasks.
+
+* No more need to declare scalac dependencies:
+```groovy
+// can safely delete this from build scripts
+dependencies {
+    scoverage group: 'org.scoverage', name: 'scalac-scoverage-plugin_2.12', version: '1.3.1'
+    scoverage group: 'org.scoverage', name: 'scalac-scoverage-runtime_2.12', version: '1.3.1'
+}
+```
+
+* All configurations are configured in `scoverage` block. For instance:
+```groovy
+// do this
+scoverage {
+    minimumRate = 0.5
+}
+
+// instead of this
+checkScoverage {
+    minimumRate = 0.5
+}
+```
+
+* No more need to declare aggregation task:
+```groovy
+// can safely delete this from build scripts
+task aggregateScoverage(type: org.scoverage.ScoverageAggregate)
+checkScoverage {
+     reportDir = file("$buildDir/scoverage-aggregate")
+}
+```
+
+Release history
+---------------
+
+##### (not released yet) - 3.0.0
+
+* Auto resolution of scalac plugin dependencies.
+* Aggregation task declared by default.
+* Deletion of non-instrumented classes, allowing for better integration with other coverage tools such as cobertura.
+* Ability to execute coverage without "normal" compilation, thus reducing build times.