diff --git a/README.md b/README.md index a929e29..0a0340c 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,16 @@ used in all Vox Pupuli gems. In your Gemfile, add the following: ``` -gem 'voxpupuli-rubocop', '~> 1.1' +gem 'voxpupuli-rubocop', '~> 2.1.0' ``` +**We suggest to pin the minor version like above, because new minor versions will pull in newer rubocop versions** + +(A best practice, that we also follow in our Vox Pupuli Ruby Gems, is to pin +like above and use dependabot. It will provide pull requests that allow +newer minor versions. And in a CI pipeline you will see if the newer rubocop +works without issues. That prevents your HEAD branch from breaking.) + In your Rakefile, include our Rake task: ```