From 75934047ee63527c924c0308a7aa0a4ac1049502 Mon Sep 17 00:00:00 2001
From: Palanisamy Easwaramoorthy <samy.e@monstar-lab.com.sg>
Date: Tue, 9 Jun 2020 23:24:21 +0800
Subject: [PATCH] updated readme

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 78c0451..793218d 100644
--- a/README.md
+++ b/README.md
@@ -20,4 +20,20 @@ uses: monstar-lab-oss/sonarqube-github-action@v1
 with:
   url: ${{ secrets.SONARQUBE_URL }}
   token: ${{ secrets.SONARQUBE_TOKEN }}
+```
+
+## SonarQube Analysis Parameters
+Except 'sonar.host.url' and 'sonar.login' you can have your project configuration file 'sonar-project.properties' for sonar scanner in root directory of your project repo.
+
+Please make sure your run the unit tests before running the sonar scanner to generate the code coverage report.
+
+Example : sonar-project.properties
+```bash
+sonar.language=php
+sonar.php.tests.reportPath=tests/report/junit.xml
+sonar.php.coverage.reportPaths=tests/report/coverage.xml
+sonar.projectKey=example-project
+sonar.projectName=example-project
+sonar.sources=./app
+sonar.sourceEncoding=UTF-8
 ```
\ No newline at end of file