Skip to content

Commit 0e2c284

Browse files
committed
docs
1 parent 3480dd4 commit 0e2c284

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
# gitcoverage
44

55
Generate code coverage badge and push it and optional HTML report to the 'coverage' branch.
6+
7+
This action has no dependencies except for `git`, the `bash` shell and common *nix command line utilities
8+
`awk`, `sed` and GNU coreutils (`mkdir, cp, rm, ls, cat, echo, printf`).
9+
10+
## Usage
11+
612
You need to have given write permissions for the for the workflow.
713
If the 'coverage' branch does not exist, it will be created as an orphan (without main repo history).
814
Reference the generated badge in your README.md like this:
@@ -15,7 +21,7 @@ If you submitted a detailed HTML report of the coverage to the action, replace t
1521

1622
`https://htmlpreview.github.io/?https://github.com/USERNAME/REPO/blob/coverage/BRANCH/report.html`
1723

18-
# Examples
24+
## Examples
1925

2026
Inside your .github/workflows/workflow.yml file:
2127

0 commit comments

Comments
 (0)