From 028e8cb85bb4516c8e50a080bec19c977a8eeeb3 Mon Sep 17 00:00:00 2001 From: Michael Baudino Date: Tue, 9 Oct 2018 08:30:30 +0200 Subject: [PATCH] Merge redundant usage instructions in README --- README.md | 24 +++++------------------- 1 file changed, 5 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 5255e97..5f571e3 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,11 @@ Code style used by AlpineLab in all our projects. ## Usage -1. Add `rubocop` gems to your `Gemfile` (or `gems.rb`, or `gems.deps.rb`): +1. Add those gems to your `Gemfile` (or `gems.rb`, or `gems.deps.rb`): ```ruby group :development, :test do + gem "alpinelab-codestyle", "~> x.y", require: false gem "rubocop", "~> x.y", require: false gem "rubocop-md", "~> x.y", require: false end @@ -16,31 +17,16 @@ Code style used by AlpineLab in all our projects. or install them manually: ```shell - gem install rubocop rubocop-md + gem install alpinelab-codestyle rubocop rubocop-md ``` -2. Add `alpinelab-codestyle` gem to your `Gemfile` -(or `gems.rb`, or `gems.deps.rb`): - - ```ruby - group :development, :test do - gem "alpinelab-codestyle", "~> x.y" - end - ``` - - or install it manually: - - ```shell - gem install alpinelab-codestyle - ``` - -3. Create or prepend your Rubocop configuration (usually `.rubocop.yml`) with: +2. Create or prepend your Rubocop configuration (usually `.rubocop.yml`) with: ```yaml inherit_gem: alpinelab-codestyle: - config/default.yml - - config/rails.yml + - config/rails.yml # for Rails projects only ``` ## Best practices