Skip to content

Commit

Permalink
Merge pull request #6 from alphagov/update-readme
Browse files Browse the repository at this point in the history
Fix rubocop config file reference in README
  • Loading branch information
theseanything authored Nov 6, 2019
2 parents 942f65f + fdbbedb commit 6d99b5f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ This repository provides common RuboCop rules for use with GOV.UK Ruby projects
## 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
Expand All @@ -21,7 +23,7 @@ inherit_gem:
or if you also need Rails specific rules:
```yaml
# .rubocop
# .rubocop.yml
inherit_gem:
rubocop-govuk:
- config/default.yml
Expand Down

0 comments on commit 6d99b5f

Please sign in to comment.