.

Author: RadoBuransky

README.md

@@ -4,6 +4,22 @@
 
 Plugin for [SonarQube] that imports statement coverage generated by [Scoverage] for Scala projects.
 
+Scoverage measures how many statements of a given Scala program have been covered by automated tests. This
+new metric is much better for Scala than traditional line coverage and branch coverage because typically:
+
+ 1. There are many statements on a single line
+ 2. `if` statements are used rarely
+
+This plugin reads XML report generated by Scoverage and populates several metrics in Sonar:
+
+ 1. Total number of statements
+ 2. Number of statements covered by tests
+ 3. Statement coverage rate (%)
+
+Projects with sub-projects are supported as well. Overall statement coverage is (sum of number of covered statements
+for all sub-projects) / (total number of statements for all sub-projects). In other words, it's more intelligent than
+just plain average of coverage rates for sub-projects.
+
 ## Requirements ##
 
 - [SonarQube] 4.0
@@ -28,11 +44,11 @@ root directory:
 If your project is based on SBT and you're using [Scoverage plugin for SBT] [sbt-scoverage] you can
 generate the Scoverage report by executing following from command line:
 
-    sbt clean scoverage:test
+    $ sbt clean scoverage:test
 
 And then run Sonar runner to upload the report to the Sonar server:
 
-    sonar-runner
+    $ sonar-runner
 
 ## Add statement coverage columns ##