README.md in undercover-0.1.2 vs README.md in undercover-0.1.3
- old
+ new
@@ -1,11 +1,13 @@
# undercover 👮♂️
**RuboCop for code coverage**
-Meaningful warnings for methods and classes which lack testing, using data from coverage reports, git metadata and a parsed structure of your Ruby codebase. `undercover` automates the coverage feedback loop and makes sure no code review passes without tests.
+**Inspects files in a git diff and warns on methods, classes and blocks which need test coverage.** Use it locally or as part of an automated build to shorten your code coverage feedback loop!
+Technically, `undercover` combines data from git, coverage reports and code structure graphs.
+
A sample output of `undercover` ran before a commit may look like this:
![screenshot warning](screenshot_warnings.png)
And like this, given that specs were added:
@@ -34,12 +36,10 @@
$ gem install undercover
## Setting up required LCOV reporting
-Undercover depends on a git diff, code structure generated by [`imagen`](https://github.com/grodowski/imagen_rb) and a coverage report in LCOV format.
-
To make your specs compatible with `undercover` by providing an LCOV report, please add `simplecov` and `simplecov-lcov` to your test setup. Example for rspec:
```ruby
# Gemfile
group :test do
@@ -94,10 +94,10 @@
The defaults assume that the program is run from the top level of the project directory.
## Development
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake` to run the tests and RuboCop. You can also run `pry -r 'undercover'` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing