README.md in rubocop-changes-0.1.2 vs README.md in rubocop-changes-0.2.0
- old
+ new
@@ -1,9 +1,9 @@
# Rubocop::Changes
-[](http://badge.fury.io/rb/rubocop-changes)
-[](https://travis-ci.org/fcsonline/rubocop-changes)
+[](https://rubygems.org/gems/rubocop-changes)
+[](https://travis-ci.com/fcsonline/rubocop-changes)
`rubocop-changes` runs rubocop and shows only the offenses you introduced since
the fork point of your git branch. Will not complain about existing offenses in
your main branch.
@@ -32,24 +32,28 @@
## Usage
$ bundle exec rubocop-changes
-## Alternatives
+## Other gems
-There are similar projects out there, but all of them show all Rubocop offenses for all changes files:
+There are similar projects out there, like
+[rubocop-git](https://github.com/m4i/rubocop-git),
+[diffcop](https://github.com/yohira0616/diffcop),
+[nexocop](https://github.com/SimpleNexus/nexocop), but not all of them offer
+differences at line level. Only
+[rubocop-git](https://github.com/m4i/rubocop-git) offer this nice feature but
+you have to craft the commit id to get the proper fork point of your pull
+request.
-- https://github.com/m4i/rubocop-git
-- https://github.com/packsaddle/rubocop-select
-- https://github.com/mcgain/rubocop-diff
-- https://github.com/yohira0616/diffcop
-- https://github.com/SimpleNexus/nexocop
+rubocop-changes does this diff out of the box without specify any commit id. If
+you want to get the offense comparing from one specific commit, you can pass
+the argument `commit` to the command.
## Ideas
Those are some ideas to improve `rubocop-changes`:
-- [ ] Let users specify which formatter to use for the output
- [ ] Let users specify the rubocop config file
## 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.