Skip to content

Commit ebc4698

Browse files
author
Federico Moyá
authored
Update README.md
1 parent 255214d commit ebc4698

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
11
# JSON formatter for SimpleCov
22

3-
JSON formatter for the SimpleCov gem.
3+
***Note: To learn more about SimpleCov, check out the main repo at [https://github.com/simplecov-ruby/simplecov](https://github.com/colszowka/simplecov***)***
4+
5+
Generates a formatted JSON report of your [SimpleCov](https://github.com/simplecov-ruby/simplecov) ruby code coverage results on ruby 2.4+.
6+
7+
## Overview
8+
9+
You can expect for this gem to produce a `coverage.json` file, located at the `coverage` folder.
10+
11+
Depending on your `SimpleCoV`'s settings you will experiment different outcomes. Particularly depending on which type of coverage are you running `SimpleCov` wit:
12+
13+
- If you configure `SimpleCov` to run with `branch` coverage you should expect an output formatted like [sample_with_branch.json](https://github.com/fede-moya/simplecov_json_formatter/blob/master/spec/fixtures/sample_with_branch.json)
14+
- Otherwise you should expect an output formatted like [sample.json](https://github.com/fede-moya/simplecov_json_formatter/blob/master/spec/fixtures/sample.json)
15+
16+
## Copyright
17+
18+
See License ?

0 commit comments

Comments
 (0)