chore: readme and package description update

mcarvin8 · mcarvin8 · commit 71f416306c69 · 2024-03-04T17:34:52.000-05:00
diff --git a/README.md b/README.md
@@ -16,6 +16,8 @@ This will create a coverage JSON in this relative path - `coverage/coverage/cove
 
 This JSON isn't accepted by SonarQube automatically and needs to be converted using this plugin.
 
+After this plugin creates the XML, you can pass the XML file-path to SonarQube using the `sonar.coverageReportPaths` flag.
+
 **Note**: This has been tested and confirmed on code which meets 100% coverage.
 
 ## Install
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "apex-code-coverage-transformer",
-  "description": "Transforms the Apex Code Coverage JSON into the Generic Test Data Report.",
+  "description": "Transforms the Apex Code Coverage JSON into the Generic Test Coverage Format.",
   "version": "1.4.1-beta.1",
   "dependencies": {
     "@oclif/core": "^3.18.1",

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "apex-code-coverage-transformer",`
`3`		`- "description": "Transforms the Apex Code Coverage JSON into the Generic Test Data Report.",`
	`3`	`+ "description": "Transforms the Apex Code Coverage JSON into the Generic Test Coverage Format.",`
`4`	`4`	`"version": "1.4.1-beta.1",`
`5`	`5`	`"dependencies": {`
`6`	`6`	`"@oclif/core": "^3.18.1",`