README.md in rubocop-rubycw-0.1.0 vs README.md in rubocop-rubycw-0.1.1
- old
+ new
@@ -1,10 +1,10 @@
-# Rubocop::Rubycw
+# RuboCop Rubycw
-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/rubycw`. To experiment with that code, run `bin/console` for an interactive prompt.
+Integrate RuboCop and `ruby -cw`.
-TODO: Delete this and the text above, and describe your gem
+You can get Ruby's warning as a RuboCop offense by rubocop-rubycw.
## Installation
Add this line to your application's Gemfile:
@@ -20,10 +20,14 @@
$ gem install rubocop-rubycw
## Usage
-TODO: Write usage instructions here
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-rubycw
+```
## Development
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.