You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-10Lines changed: 11 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -6,18 +6,19 @@ CoverageBadge is a library for creating an SVG coverage badge from a Clover XML
6
6
7
7
## Installation
8
8
9
-
Composer
10
-
11
9
`composer require codebtech/coveragebadge --dev`
12
10
13
11
## Features
14
-
- Generate coverage badge from PHPUnit Clover XML file
15
-
- Generate coverage badge based on multiple Clover XML files, and it merges the coverage percentage automatically
16
-
- Can accept coverage name and the badge will be generated with the coverage name
17
-
12
+
- Produces a code coverage badge utilizing a Clover coverage XML file
13
+
- Creates a code coverage badge from several Clover XML files, automatically incorporating the coverage percentages
14
+
- Accepts a coverage name as an input to include in the generated badge
18
15
19
16
## Usage
20
-
21
-
1. Generate [XML Code Coverage](https://docs.phpunit.de/en/11.1/code-coverage.html) and generate [Clover](https://docs.phpunit.de/en/11.1/configuration.html#the-report-element) XML files.
22
-
2. Run `vendor/bin/coverage-badge /path/to/clover.xml /path/to/badge/destination.svg test-name`
23
-
3. To merge multiple clover files provide the input XML files `comma` separated run `vendor/bin/coverage-badge /path/to/clover.xml,/path/to/clover2.xml /path/to/badge/destination.svg test-name`
17
+
- Execute the command to generate badge for single Clover XML input
0 commit comments