From 861a8556449f8ce4d516876215f91decec91da27 Mon Sep 17 00:00:00 2001
From: Massimiliano Lattanzio <massimiliano.lattanzio@gmail.com>
Date: Tue, 1 Aug 2023 11:50:00 +0200
Subject: [PATCH] Improve README readability

---
 README.md | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 7ef5a8c..64fe826 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 Automatic Solidus code style checking tool.
 A RuboCop extension focused on enforcing Solidus best practices and coding conventions.
 
-## Installation
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -19,7 +19,7 @@ Or install it yourself as:
 
     $ gem install rubocop-solidus
 
-## Usage
+### Usage
 
 To Start using this extension in your application add the following lines to your `.rubocop.yml` file
 
@@ -34,6 +34,13 @@ After this simply use the `rubocop` command to start linting.
 
 You can read about each cop supplied by RuboCop Solidus in [the docs](docs/cops.md).
 
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/solidusio/rubocop-solidus.
+
+To contribute a new cop, please see the sections below.
+
+### Creating new cops
 
 To create a new cop, run the following command:
 
@@ -43,7 +50,7 @@ $ bundle exec rake 'new_cop[Solidus/NameOfTheCop]'
 
 and then follow the instructions on the screen.
 
-## Creating changelog entries
+### Creating changelog entries
 
 Changelog entries are just files under the `changelog/` folder that will be merged
 into `CHANGELOG.md` at release time. You can create new changelog entries like this:
@@ -54,7 +61,7 @@ $ bundle exec rake changelog:new|fix|change
 
 The type of the changelog correspond to "new feature", "bug-fix" and "changed" entries in the changelog.
 
-### Changelog entry format
+#### Changelog entry format
 
 Here are a few examples:
 
@@ -71,7 +78,7 @@ Here are a few examples:
 * If this is a breaking change, mark it with `**(Breaking)**`.
 * At the end of the entry, add an implicit link to your GitHub user page as `([@username][])`.
 
-## Release a new version
+### Release a new version
 
 To release a new version, run the following command:
 
@@ -92,10 +99,6 @@ To deploy the new version to RubyGems, run the following command:
 $ bundle exec rake release
 ```
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/solidusio/rubocop-solidus.
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).