updated readme

Author: Vishal.Vaibhav

README.md

@@ -9,13 +9,21 @@ Sometimes when working to get a repo to an acceptable level of code coverage, it
 covered enough.  This plugin will look at just the lines changed in the PR and report code coverage for only those
 lines.
 
-This plugin will output the coverage details to the drone step's console, as well as has the ability to comment on the 
+This plugin will output the coverage details to the vela step's console, as well as has the ability to comment on the
 PR with a summary of the coverage details.
 
+Currently, this plugin supports two coverage file format.
+* jacoco for jvm based languages like java,kotlin,scala
+* cobertura can be used for golang projects using [gocov-xml](https://github.com/AlekSi/gocov-xml) utility
+
 
 
 ## VELA Usage
 
+### Jvm based projects
+For java/koltin based projects you need jacoco files that goes as an input to this plugin. How to generate jacoco files is outside the scope of
+this project. Once you have that jacoco file, you can pass that path to coverage_file parameters as shown in an example below
+
 ```yaml
 - name: check-pr-code-coverage
    image: docker.target.com/app/pull-request-code-coverage
@@ -36,6 +44,36 @@ PR with a summary of the coverage details.
 ```
 
 
+### Golang based projects
+You can use [gocov-xml](https://github.com/AlekSi/gocov-xml) utility to generate coverage.xml
+```
+ - go get github.com/axw/gocov/gocov
+ - go get github.com/AlekSi/gocov-xml
+ - go test -v -coverpkg=./... -coverprofile=coverage.txt ./...
+ - go tool cover -func=coverage.txt
+ - gocov convert coverage.txt | gocov-xml > ./coverage.xml
+```
+
+Once you have coverage.xml same can  be passed as an input to plugin shown below
+
+```yaml
+- name: check-pr-code-coverage
+   image: docker.target.com/app/pull-request-code-coverage
+   pull: true
+   ruleset:
+     event: [pull_request]
+   parameters:
+     coverage_type: cobertura
+     #coverage.xml generated in above step
+     coverage_file: coverage.xml
+     source_dirs:
+       - /vela/src/git.target.com/TargetOSS/pull-request-code-coverage
+     gh_api_base_url: https://git.target.com
+   secrets:
+     - source: pull_request_api_key
+       target: plugin_gh_api_key
+```
+
 #### Parameters
 
 |param|required| default | description|
@@ -46,3 +84,10 @@ PR with a summary of the coverage details.
 |gh_api_base_url| false | | base url of the gh api for posting coverage comments<br><br>if not set, coverage details will not be commented on PR   |
 |gh_api_key| false | | api key to auth for posting coverage comments<br><br>if not set, coverage details will not be commented on PR  |
 |module | false  | \<empty string\> | sub-module to use if operating inside a multi-module project (e.g. gradle multi-project build) |
+
+# Development
+
+This project needs  go (>= 1.17) to be  installed.
+
+# License
+This project is licensed under the Apache License, Version 2.0.