README.md in rubocop-gem_dev-0.1.0 vs README.md in rubocop-gem_dev-0.2.0
- old
+ new
@@ -1,17 +1,15 @@
# Rubocop::GemDev
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/gem_dev`. To experiment with that code, run `bin/console` for an interactive prompt.
+RuboCop configurations gem for gem development.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'rubocop-gem_dev'
+gem 'rubocop-gem_dev', require: false
```
And then execute:
$ bundle install
@@ -20,10 +18,16 @@
$ gem install rubocop-gem_dev
## Usage
-TODO: Write usage instructions here
+Add the snippet below to your `.rubocop.yml`
+
+```ruby
+inherit_gem:
+ rubocop-gem_dev:
+ - "config/rubocop.yml"
+```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.