Update README.md

Author: mrfyda

README.md

@@ -1,4 +1,76 @@
 # sbt-codacy-coverage
 [![Codacy Badge](https://www.codacy.com/project/badge/1146fb14534e427493469ba4b0459430)](https://www.codacy.com)
 
-Sbt plugin for uploading Scala code coverage to Codacy https://www.codacy.com
+sbt plugin for uploading Scala code coverage to Codacy https://www.codacy.com
+
+```
+sbt-codacy-coverage will only work with sbt 0.13.5 and higher.
+```
+
+## Setup
+
+Codacy assumes that coverage is previously configured for your project. As an example, we will configure a Scala project with the scoverage sbt plugin.
+
+To start, add the scoverage and Codacy sbt plugins into your plugins.sbt file:
+
+```sbt
+resolvers += "Typesafe Repository" at "https://repo.typesafe.com/typesafe/releases/"
+
+addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.0.4")
+
+addSbtPlugin("com.codacy" % "sbt-codacy-coverage" % "1.0.3")
+```
+
+Coverage should now be enabled for your project. 
+To run the tests and create coverage files, type in your terminal:
+
+```sbt
+sbt clean coverage test
+```
+
+This will create coverage reports for all your tests in your project. 
+In order to export scoverage report files into cobertura compatible files, just type:
+
+```sbt
+sbt coverageReport
+```
+
+This will create the required report format for the Codacy plugin to read.
+If you have sub-projects within your project, you will want to aggregate all reports into one by running:
+
+```sbt
+sbt coverageAggregate
+```
+
+## Updating Codacy
+
+To update Codacy, you will need your project integration token. You can find the token in Project -> Settings -> Integrations -> Coverage.
+
+Then set it in your terminal, replacing %Project_Token% with your own token:
+
+```sbt
+export CODACY_PROJECT_TOKEN=%Project_Token%
+```
+
+Next, simply run the Codacy sbt plugin. It will find the current commit and send all details to your project dashboard:
+
+```
+sbt codacyCoverage
+```
+
+## Configure your build server
+
+After setting up and testing the coverage, you're ready to setup your build server to automate your process.
+Simply replace the step used to run your tests with the process done so far, shown here for brevity sake:
+
+```sbt
+sbt clean coverage test
+sbt coverageReport
+sbt coverageAggregate
+sbt codacyCoverage
+```
+
+## Failing tests
+
+Failing tests can be caused by the usage of macros in Scala 2.10.
+Consider upgrading to Scala 2.11 for full macro support.