README.md in meowcop-1.8.0 vs README.md in meowcop-1.9.0

- old
+ new

@@ -1,14 +1,24 @@ # MeowCop [![Gem Version](https://badge.fury.io/rb/meowcop.svg)](https://badge.fury.io/rb/meowcop) -MeowCop is a RuboCop configuration recommended by Actcat inc. +MeowCop is a gem for RuboCop configuration, it focuses **Lint**. +It's recommended by Actcat inc. + +## Design + +RuboCop has many style cops. Style cops provide one of several settings. +So, sometime we get many many warnings when we introduce RuboCop. The cause is a mismatch between RuboCop's default setting and your project coding style. + In the configuration, style rules are disabled. Because the rules almost for project specific. -However, lint rules are enabled. +If you use, you can use RuboCop as a Linter without many noisy warnings. + +If you want to use RuboCop as a style checker, we recommend [Gry](https://github.com/pocke/gry). + ## Installation Add this line to your application's Gemfile: ```ruby @@ -23,16 +33,30 @@ $ gem install meowcop ## Configuration -Add the following directive to your `.rubocop.yml` +MeowCop provides a CLI tool to initialise `.rubocop.yml` -```yaml +```ruby +$ meowcop init +Meow! .rubocop.yml has been created successfully. +$ cat .rubocop.yml +# To use the MeowCop gem. inherit_gem: meowcop: - config/rubocop.yml + +# Modify the version if you don't use MRI 2.1. +AllCops: + TargetRubyVersion: 2.1 + +# You can customize rubocop settings. +# For example. +# Style/FrozenStringLiteralComment: +# Enabled: true +# EnforcedStyle: always ``` ### Example https://github.com/sideci/meowcop/blob/master/examples/.rubocop.yml @@ -43,9 +67,10 @@ Just execute RuboCop. ```sh $ bundle exec rubocop ``` + ## Development