README.md in rubocop-ruby2_6-1.0.1 vs README.md in rubocop-ruby2_6-1.0.2
- old
+ new
@@ -38,16 +38,16 @@
The purpose of this gem is to constrain the `rubocop` dependency of a project in
a [SemVer compliant](https://semver.org/) (Semantic Versioning) way that aligns with the the desired minimum
compatible/supported Ruby version.
Adding this gem will facilitate the best practice of adding a `~> ` version constrained `rubocop` dependency, while
-minimiszing the risk of a rubocop minor / patch upgrade breaking the build. See the
+minimizing the risk of a rubocop minor / patch upgrade breaking the build. See the
official [compatibility matrix](https://github.com/rubocop/rubocop/blob/master/docs/modules/ROOT/pages/compatibility.adoc#support-matrix) (Rubocop documentation)
## Stable
-All releases of this gem are stable releases. The first version is `1.0.0`.
+All releases of this gem are stable releases. The first version is `1.0.1` (1.0.0 was yanked due to accidentally requiring Ruby 3.1, failing the whole purpose of this project 🥳).
## Installation
Install the gem and add to the application's Gemfile by executing:
@@ -59,11 +59,11 @@
## Usage
The following is optional. We'll discuss why you might want to do this after you see what it does.
-Add to the top of your project's RuboCop configuration file:
+Add to the top of your project's `.rubocop.yml` configuration file:
```yaml
inherit_gem:
rubocop-ruby2_6: rubocop.yml
```
@@ -109,10 +109,31 @@
The gem is available as open source under the terms of
the [MIT License][license] [][license-ref].
See [LICENSE][license] for the official [Copyright Notice][copyright-notice-explainer].
+<details>
+ <summary>Project Logos (rubocop-ruby2_6)</summary>
+
+See [docs/images/logo/README.txt][project-logos]
+</details>
+
+<details>
+ <summary>Organization Logo (rubocop-semver)</summary>
+
+Author: [Yusuf Evli][org-logo-author]
+Source: [Unsplash][org-logo-source]
+License: [Unsplash License][org-logo-license]
+</details>
+
+[project-logos]: https://github.com/rubocop-semver/rubocop-ruby2_6/blob/main/docs/images/logo/README.txt
+[org-logo-author]: https://unsplash.com/@yusufevli
+[org-logo-source]: https://unsplash.com/photos/yaSLNLtKRIU
+[org-logo-license]: https://unsplash.com/license
+
+### Copyright
+
* Copyright (c) 2022 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
[copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
## Code of Conduct
@@ -130,10 +151,10 @@
the [Pessimistic Version Constraint][pvc] with two digits of precision.
For example:
```ruby
-spec.add_dependency "rubocop-ruby2_6", "~> 0.1"
+spec.add_dependency "rubocop-ruby2_6", "~> 1.0"
```
[copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
[gh_discussions]: https://github.com/rubocop-semver/rubocop-ruby2_6/discussions