README.md in rubocop-rickselby-0.1.0 vs README.md in rubocop-rickselby-0.2.0
- old
+ new
@@ -4,19 +4,27 @@
## Usage
Add `rubocop-rickselby` to your Gemfile:
- ```ruby
- gem "rubocop-rickselby", require: false
- ```
+```ruby
+gem "rubocop-rickselby", "~> 0.1", require: false
+# If you are using rails:
+gem "rubocop-rails", require: false
+gem "rubocop-rails-accessibility", require: false
+
+# If you are using rspec:
+gem "rubocop-capybara", require: false
+gem "rubocop-rspec", require: false
+```
+
Inherit the configuration in your `.rubocop.yml`:
- ```yaml
- # .rubocop.yml
- inherit_gem:
- rubocop-rickselby:
- - config/default.yml # generic Ruby rules and cops
- - config/rails.yml # Rails-specific rules and cops
- - config/rspec.yml # RSpec-specific rules and cops
- ```
+```yaml
+# .rubocop.yml
+inherit_gem:
+rubocop-rickselby:
+- config/default.yml # generic Ruby rules and cops
+- config/rails.yml # Rails-specific rules and cops
+- config/rspec.yml # RSpec-specific rules and cops
+```