Skip to content

Commit 43ae532

Browse files
authored
Merge pull request #10 from codebtech/chore/github-action
Update readme
2 parents cc65bf3 + 2befe30 commit 43ae532

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,19 @@ CoverageBadge is a library for creating an SVG coverage badge from a Clover XML
66

77
## Installation
88

9-
Composer
10-
119
`composer require codebtech/coveragebadge --dev`
1210

1311
## 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
1815

1916
## 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
18+
```
19+
vendor/bin/coverage-badge /path/to/clover.xml /path/to/badge/destination.svg test-name
20+
```
21+
- To blend multiple Clover files, enumerate the XML inputs separated by commas and use the command
22+
```
23+
vendor/bin/coverage-badge /path/to/clover.xml,/path/to/clover2.xml /path/to/badge/destination.svg test-name
24+
```

0 commit comments

Comments
 (0)