README.md in meowcop-2.1.0 vs README.md in meowcop-2.2.0
- old
+ new
@@ -1,78 +1,83 @@
# MeowCop
[![Gem Version](https://badge.fury.io/rb/meowcop.svg)](https://badge.fury.io/rb/meowcop)
-MeowCop is a gem for RuboCop configuration, it focuses **Lint**.
+MeowCop is a gem for shareable [RuboCop](https://www.rubocop.org) configuration, it focuses [Lint](https://en.wikipedia.org/wiki/Lint_(software)).
It's recommended by Sider, 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.
+RuboCop has many stylistic rules (RuboCop call a rule "Cop"). ["Style Cops"](https://www.rubocop.org/en/stable/cops_style/) provide one of several settings.
+So, we encounter many many warnings when we introduce RuboCop. The cause is a mismatch between the RuboCop's default settings and your project's coding style.
-In the configuration, style rules are disabled. Because the rules almost for project specific.
-If you use, you can use RuboCop as a Linter without many noisy warnings.
+In the configuration of MeowCop, almost all stylistic rules are disabled. Because such rules are almost specific for your project.
+If you want, you can use RuboCop as a **Linter** without many noisy warnings.
+In contrast, if you want to use RuboCop as a style checker, we recommend [Gry](https://github.com/pocke/gry).
-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
gem 'meowcop'
```
And then execute:
- $ bundle
+```sh
+$ bundle install
+```
Or install it yourself as:
- $ gem install meowcop
+```sh
+$ gem install meowcop
+```
## Configuration
-MeowCop provides a CLI tool to initialise `.rubocop.yml`
+MeowCop provides a CLI tool to initialize `.rubocop.yml`. See below:
```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.6.
AllCops:
TargetRubyVersion: 2.6
-# You can customize rubocop settings.
+# You can customize RuboCop settings.
# For example.
# Style/FrozenStringLiteralComment:
# Enabled: true
# EnforcedStyle: always
```
### Example
-https://github.com/sider/meowcop/blob/master/examples/.rubocop.yml
+See this [example](examples/.rubocop.yml).
-
## Usage
-Just execute RuboCop.
+Just execute RuboCop with `.rubocop.yml` configured by MeowCop:
```sh
$ bundle exec rubocop
```
+Or,
-
+```sh
+$ rubocop
+```
## 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.