Updated readme

README.md

@@ -1,10 +1,11 @@
-# Coverity VSTS Build Task
+# Coverity Azure DevOps Build Task
 
 Please note that this is very much a work-in-progress and it is only built to facilitate the needs I/We have at work (http://www.infosoft.no).
 Feel free to make comments, suggestion, PRs etc, but don't expect too much in the way of "bug fixing" if you discover a bug.
 
+The repository is called vsts-task because that was the name of Azure DevOps at the time of creation (and I should have known it would change name again and just not used that name, but anyway, there you have it).
 
-# Installing the Coverity Build Task
+# Installing the Coverity Build Task into Azure DevOps
 * Install Node.js
 * Install the tfx-cli using `npm install -g tfx-cli`
 * Clone the repository `git clone https://github.com/esbenbach/coverity-vsts-task.git`
@@ -18,3 +19,20 @@ Feel free to make comments, suggestion, PRs etc, but don't expect too much in th
 # Regarding MSBuild
 Since this is my very first attempt to do a vsts task, i took the quick way around and just used a third party script to find msbuild, and I choose to just use the arguments for MSBuild that I need.
 It should be relatively easy to augment it if you want, but ideally it should somehow wrap the VSBuild task if that is possible (not sure it is). I might look into that in the future.
+
+# How it works
+The task works by going through the following steps:
+
+* cov-build
+* cov-import-scm (if enabled)
+* cov-analyze
+* cov-commit-defects
+
+At each step there are a series of default options passed to the cli tool, and it is possible to pass along custom arguments.
+
+If system.debug is set to true (diagnostics is enabled), the task will output the commands it is trying to execute to help in troubleshooting.
+
+The cov-build wraps around a sln file - im guessing that any sort of msbuild type reference will work, but I actually don't know.
+
+## Assumptions
+This assumes that Coverity is installed on the build server and available in the Path, it also assumes that the build server has access to a key file so defects can be comitted to coverity connect.