README.md in equatable-0.6.1 vs README.md in equatable-0.7.0
- old
+ new
@@ -1,30 +1,30 @@
# Equatable
[![Gem Version](https://badge.fury.io/rb/equatable.svg)][gem]
-[![Build Status](https://secure.travis-ci.org/piotrmurach/equatable.svg?branch=master)][travis]
+[![Actions CI](https://github.com/piotrmurach/equatable/workflows/CI/badge.svg?branch=master)][gh_actions_ci]
[![Build status](https://ci.appveyor.com/api/projects/status/lsb02nm0g4c6guiu?svg=true)][appveyor]
[![Code Climate](https://codeclimate.com/github/piotrmurach/equatable/badges/gpa.svg)][codeclimate]
[![Coverage Status](https://coveralls.io/repos/github/piotrmurach/equatable/badge.svg)][coverage]
[![Inline docs](http://inch-ci.org/github/piotrmurach/equatable.svg?branch=master)][inchpages]
[gem]: http://badge.fury.io/rb/equatable
-[travis]: http://travis-ci.org/piotrmurach/equatable
+[gh_actions_ci]: https://github.com/piotrmurach/equatable/actions?query=workflow%3ACI
[appveyor]: https://ci.appveyor.com/project/piotrmurach/equatable
[codeclimate]: https://codeclimate.com/github/piotrmurach/equatable
[coverage]: https://coveralls.io/github/piotrmurach/equatable
[inchpages]: http://inch-ci.org/github/piotrmurach/equatable
-Allows ruby objects to implement equality comparison and inspection methods.
+> Provide equality comparison methods for objects based on their attributes.
-By including this module, a class indicates that its instances have explicit general contracts for `hash`, `==` and `eql?` methods. Specifically `eql?` contract requires that it implements an equivalence relation. By default each instance of the class is equal only to itself. This is a right behaviour when you have distinct objects. However, it is the responsibility of any class to clearly define their equality. Failure to do so may prevent instances to behave as expected when for instance `Array#uniq` is invoked or when they are used as `Hash` keys.
+By including this module, a class indicates that its instances have explicit general contracts for `==`, `eql?` and `hash` methods. Specifically the `eql?` contract requires that it implements an equivalence relation. By default, each instance of a class is equal only to itself. This is the right behaviour when you have distinct objects. However, it is the responsibility of any class to clearly define its equality. Failure to do so may prevent instances from behaving as expected when tested for uniqueness in Array#uniq or when used as Hash keys.
## Installation
Add this line to your application's Gemfile:
- gem 'equatable'
+ gem "equatable"
And then execute:
$ bundle
@@ -100,9 +100,13 @@
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+## Code of Conduct
+
+Everyone interacting in the Equatable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/equatable/blob/master/CODE_OF_CONDUCT.md).
## Copyright
Copyright (c) 2012 Piotr Murach. See LICENSE for further details.