Merge pull request #175 from codacy/documentation-fix

docs: Document partial reports with the script
codacy · Mar 10, 2020 · 7fbca97 · 7fbca97
2 parents 588d34a + 2337cf8
commit 7fbca97
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -27,3 +27,4 @@ codacy-coverage-reporter-linux-*
 codacy-coverage-reporter-darwin-*
 classes/
 src/test/resources/codacy-coverage.json
+/.codacy-coverage/
diff --git a/README.md b/README.md
@@ -84,6 +84,12 @@ In order to send multiple reports for the same language, you need to upload each
 1. `codacy-coverage-reporter report -l Java -r report2.xml --partial`
 1. `codacy-coverage-reporter final`
 
+**_Using the script_**
+
+1. `bash <(curl -Ls https://coverage.codacy.com/get.sh) report -l Java -r report1.xml --partial`
+1. `bash <(curl -Ls https://coverage.codacy.com/get.sh) report -l Java -r report2.xml --partial`
+1. `bash <(curl -Ls https://coverage.codacy.com/get.sh) final`
+
 If you are sending reports with the partial flag for a certain language you should use it in all reports for that language to ensure the correct calculation of the coverage.
 
 It might also be possible to merge the reports before uploading them to Codacy, since most coverage tools support merge/aggregation, example: http://www.eclemma.org/jacoco/trunk/doc/merge-mojo.html.