README.md in rubocop-govuk-1.0.0 vs README.md in rubocop-govuk-2.0.0
- old
+ new
@@ -3,26 +3,28 @@
This repository provides common RuboCop rules for use with GOV.UK Ruby projects to comply with our [style guides][guides].
## Installation
Add `rubocop-govuk` to your Gemfile and then run `bundle install`:
+
```ruby
# Gemfile
gem 'rubocop-govuk'
```
Inherit rules from the gem by adding the following to your project's RuboCop config:
+
```yaml
-# .rubocop
+# .rubocop.yml
inherit_gem:
rubocop-govuk:
- config/default.yml
```
or if you also need Rails specific rules:
```yaml
-# .rubocop
+# .rubocop.yml
inherit_gem:
rubocop-govuk:
- config/default.yml
- config/rails.yml
```