readme.md in covered-0.25.1 vs readme.md in covered-0.26.0
- old
+ new
@@ -9,12 +9,11 @@
coverage - so you can incrementally work on improving coverage.
- Integration with Sus, Git, RSpec and Minitest- no need to configure anything - out of the box support for these
platforms.
- Supports coverage of views - templates compiled to Ruby code can be tracked for coverage reporting.
-[![Development
-Status](https://github.com/ioquatix/covered/workflows/Test/badge.svg)](https://github.com/ioquatix/covered/actions?workflow=Test)
+[![Development Status](https://github.com/ioquatix/covered/workflows/Test/badge.svg)](https://github.com/ioquatix/covered/actions?workflow=Test)
## Motivation
Originally, Ruby coverage tools were unable to handle `eval`ed code. This is because the `coverage` module built into
Ruby doesn't expose the necessary hooks to capture it. Using the [parser](https://github.com/whitequark/parser) gem and
@@ -23,15 +22,16 @@
After this concept prooved useful, [it was integrated directly into Ruby](https://bugs.ruby-lang.org/issues/19008).
## Usage
-Please see the [project documentation](https://github.com/ioquatix/covered) for more details.
+Please see the [project documentation](https://ioquatix.github.io/covered/) for more details.
- - [Getting Started](https://github.com/ioquatix/coveredguides/getting-started/index) - This guide explains how to get
- started with `covered` and integrate it with your test suite.
+ - [Getting Started](https://ioquatix.github.io/covered/guides/getting-started/index) - This guide explains how to get started with `covered` and integrate it with your test suite.
+ - [Configuration](https://ioquatix.github.io/covered/guides/configuration/index) - This guide will help you to configure covered for your project's specific requirements.
+
## See Also
- [simplecov](https://github.com/colszowka/simplecov) – one of the original coverage implementations for Ruby, uses
the built-in `coverage` library.
- [sus](https://github.com/ioquatix/sus) - a test framework which uses `covered` to generate coverage reports.
@@ -46,12 +46,10 @@
4. Push to the branch (`git push origin my-new-feature`).
5. Create new Pull Request.
### Developer Certificate of Origin
-This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this
-project must agree to this document to have their contributions accepted.
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
### Contributor Covenant
-This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and
-participants agree to abide by its terms.
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.