Skip to content

Commit 76d0497

Browse files
authored
Update README.md
1 parent 6b987f2 commit 76d0497

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# commitstat
22

3-
A CI tool for reporting and comparing stats on commits. It can parse a stat from a file or stdin, check whether the number has increased or decreased, and then report a pass/fail status.
3+
A CI tool for reporting and comparing stats on commits and pull requests.
4+
It can parse a stat from a file or stdin,
5+
check whether the number has increased or decreased from the previous commit or main branch,
6+
and then report a pass/fail status on GitHub.
47

58
Can be used to check test coverage, typing coverage, file sizes, and more.
69

@@ -12,6 +15,10 @@ $ commitstat coverage-report.txt --regex "\| Total\s*\|\s*([\d\.]+%)" --goal inc
1215
$ stat -f %z app.zip | commitstat - --name app-size
1316
```
1417

18+
This is a lightweight alternative to hosted services like [Codecov](https://about.codecov.io/) and [Coveralls](https://coveralls.io/).
19+
All of the data that commitstat uses is stored directly in the GitHub commit status and doesn't involve any third-party services or hosting.
20+
There aren't any visualization tools built-in but you can always store artifacts in your CI provider or look at coverage reports locally.
21+
1522
## Quick install
1623

1724
```console

0 commit comments

Comments
 (0)