README.md in u-attributes-2.6.0 vs README.md in u-attributes-2.7.0
- old
+ new
@@ -1,14 +1,14 @@
<p align="center">
<img src="./assets/u-attributes_logo_v1.png" alt='Create "immutable" objects. No setters, just getters!'>
- <p align="center"><i>Create "immutable" objects. No setters, just getters!</i></p>
+ <p align="center"><i>Create "immutable" objects with no setters, just getters.</i></p>
<br>
</p>
<p align="center">
- <img src="https://img.shields.io/badge/ruby-2.2+-ruby.svg?colorA=99004d&colorB=cc0066" alt="Ruby">
+ <img src="https://img.shields.io/badge/ruby->%3D%202.2.0-ruby.svg?colorA=99004d&colorB=cc0066" alt="Ruby">
<a href="https://rubygems.org/gems/u-attributes">
<img alt="Gem" src="https://img.shields.io/gem/v/u-attributes.svg?style=flat-square">
</a>
@@ -23,13 +23,21 @@
<a href="https://codeclimate.com/github/serradura/u-attributes/test_coverage">
<img alt="Test Coverage" src="https://api.codeclimate.com/v1/badges/b562e6b877a9edf4dbf6/test_coverage">
</a>
</p>
-This gem allows you to define "immutable" objects, and your objects will have only getters and no setters.
-So, if you change [[1](#with_attribute)] [[2](#with_attributes)] some object attribute, you will have a new object instance. That is, you transform the object instead of modifying it.
+This gem allows you to define "immutable" objects, when using it your objects will only have getters and no setters.
+So, if you change [[1](#with_attribute)] [[2](#with_attributes)] an attribute of the object, you’ll have a new object instance. That is, you transform the object instead of modifying it.
+## Documentation <!-- omit in toc -->
+
+Version | Documentation
+---------- | -------------
+unreleased | https://github.com/serradura/u-case/blob/main/README.md
+2.7.0 | https://github.com/serradura/u-case/blob/v2.x/README.md
+1.2.0 | https://github.com/serradura/u-case/blob/v1.x/README.md
+
# Table of contents <!-- omit in toc -->
- [Installation](#installation)
- [Compatibility](#compatibility)
- [Usage](#usage)
- [How to define attributes?](#how-to-define-attributes)
@@ -83,10 +91,11 @@
# Compatibility
| u-attributes | branch | ruby | activemodel |
| -------------- | ------- | -------- | ------------- |
-| 2.6.0 | main | >= 2.2.0 | >= 3.2, < 6.1 |
+| unreleased | main | >= 2.2.0 | >= 3.2, < 7 |
+| 2.7.0 | v2.x | >= 2.2.0 | >= 3.2, < 7 |
| 1.2.0 | v1.x | >= 2.2.0 | >= 3.2, < 6.1 |
> **Note**: The activemodel is an optional dependency, this module [can be enabled](#activemodelvalidation-extension) to validate the attributes.
[⬆️ Back to Top](#table-of-contents-)