versionaire 8.0.1 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c79d0a45805594ba63401cdcefe4378221a9792f218187619c48bfee60aa7a14
-  data.tar.gz: c873a28ec96bf5bd56125772ea3e26458aaf5aebe069b4db93169d972d76b41d
+  metadata.gz: d20b3927b31e04a6aa4db539594e3826114c9059bbdbbc7bf82db8cc2bb1642b
+  data.tar.gz: c8f52778a5a07e77d819e525e5a9e8faf00f342280757261972ee73d49dfca1f
 SHA512:
-  metadata.gz: '09209a0a888f5b8eefb9d28acdb9bb22464a8155ca70f1165790d955c2aa32a2d9d02f0232fbdc5d56231edd2c5562a0d65d73f760504110b00946f2729cafa3'
-  data.tar.gz: 463e1bec546994e1924b66549d9bd90bf72bd00b362a611092598b0766f689638c61de9e04a2ed1a259a23e357bc696e68319cb4db2763b2ee7d4754451dae9e
+  metadata.gz: e6541aa88de4802b6e7341b8f6b9deeceb5b33a95533de0255f41485f0be754fe66067b9ce03c3bee0936d25ed14589f359effe3e595616424acbfbbe36d2fc7
+  data.tar.gz: 6922a4629f06dba48a05068301160e7861fcf9780d3a29552d65f6d4d9e16f2cbe1dab590b158990316def5c18f79f36a467eb8453a4b91a0378939b36f8684b

data/{LICENSE.md → LICENSE.adoc}

@@ -1,4 +1,4 @@
-# Apache License
+= Apache License
 
 Version 2.0, January 2004
 
@@ -6,7 +6,7 @@ http://www.apache.org/licenses
 
 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-## 1. Definitions
+== 1. Definitions
 
 "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
 Sections 1 through 9 of this document.
@@ -54,14 +54,14 @@ Contribution."
 "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
 Contribution has been received by Licensor and subsequently incorporated within the Work.
 
-## 2. Grant of Copyright License
+== 2. Grant of Copyright License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
 reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
 distribute the Work and such Derivative Works in Source or Object form.
 
-## 3. Grant of Patent License
+== 3. Grant of Patent License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
@@ -74,39 +74,38 @@ a Contribution incorporated within the Work constitutes direct or contributory p
 then any patent licenses granted to You under this License for that Work shall terminate as of the
 date such litigation is filed.
 
-## 4. Redistribution
+== 4. Redistribution
 
 You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
 or without modifications, and in Source or Object form, provided that You meet the following
 conditions:
 
-1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+. You must give any other recipients of the Work or Derivative Works a copy of this License; and
 
-2. You must cause any modified files to carry prominent notices stating that You changed the
-   files; and
+. You must cause any modified files to carry prominent notices stating that You changed the files;
+  and
 
-3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
-   patent, trademark, and attribution notices from the Source form of the Work, excluding those
-   notices that do not pertain to any part of the Derivative Works; and
+. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
+  patent, trademark, and attribution notices from the Source form of the Work, excluding those
+  notices that do not pertain to any part of the Derivative Works; and
 
-4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative
-   Works that You distribute must include a readable copy of the attribution notices contained
-   within such NOTICE file, excluding those notices that do not pertain to any part of the
-   Derivative Works, in at least one of the following places: within a NOTICE text file
-   distributed as part of the Derivative Works; within the Source form or documentation, if
-   provided along with the Derivative Works; or, within a display generated by the Derivative
-   Works, if and wherever such third-party notices normally appear. The contents of the NOTICE
-   file are for informational purposes only and do not modify the License. You may add Your own
-   attribution notices within Derivative Works that You distribute, alongside or as an addendum to
-   the NOTICE text from the Work, provided that such additional attribution notices cannot be
-   construed as modifying the License.
+. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works
+  that You distribute must include a readable copy of the attribution notices contained within such
+  NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
+  at least one of the following places: within a NOTICE text file distributed as part of the
+  Derivative Works; within the Source form or documentation, if provided along with the Derivative
+  Works; or, within a display generated by the Derivative Works, if and wherever such third-party
+  notices normally appear. The contents of the NOTICE file are for informational purposes only and
+  do not modify the License. You may add Your own attribution notices within Derivative Works that
+  You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such
+  additional attribution notices cannot be construed as modifying the License.
 
 You may add Your own copyright statement to Your modifications and may provide additional or
 different license terms and conditions for use, reproduction, or distribution of Your modifications,
 or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
 the Work otherwise complies with the conditions stated in this License.
 
-## 5. Submission of Contributions
+== 5. Submission of Contributions
 
 Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
 Work by You to the Licensor shall be under the terms and conditions of this License, without any
@@ -114,13 +113,13 @@ additional terms or conditions. Notwithstanding the above, nothing herein shall
 the terms of any separate license agreement you may have executed with Licensor regarding such
 Contributions.
 
-## 6. Trademarks
+== 6. Trademarks
 
 This License does not grant permission to use the trade names, trademarks, service marks, or product
 names of the Licensor, except as required for reasonable and customary use in describing the origin
 of the Work and reproducing the content of the NOTICE file.
 
-## 7. Disclaimer of Warranty
+== 7. Disclaimer of Warranty
 
 Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
 Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -129,7 +128,7 @@ TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. Y
 responsible for determining the appropriateness of using or redistributing the Work and assume any
 risks associated with Your exercise of permissions under this License.
 
-## 8. Limitation of Liability
+== 8. Limitation of Liability
 
 In no event and under no legal theory, whether in tort (including negligence), contract, or
 otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
@@ -139,7 +138,7 @@ License or out of the use or inability to use the Work (including but not limite
 loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
 damages or losses), even if such Contributor has been advised of the possibility of such damages.
 
-## 9. Accepting Warranty or Additional Liability
+== 9. Accepting Warranty or Additional Liability
 
 While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
 for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
@@ -151,11 +150,11 @@ additional liability.
 
 END OF TERMS AND CONDITIONS
 
-Copyright 2016 [Alchemists](https://www.alchemists.io).
+Copyright link:https://www.alchemists.io[Alchemists].
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
-compliance with the License. You may obtain a [copy](http://www.apache.org/licenses/LICENSE-2.0) of
-the License.
+compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]
+of the License.
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is
 distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

data/README.adoc

@@ -0,0 +1,254 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+= Versionaire
+
+[link=http://badge.fury.io/rb/versionaire]
+image::https://badge.fury.io/rb/versionaire.svg[Gem Version]
+[link=https://circleci.com/gh/bkuhlmann/versionaire]
+image::https://circleci.com/gh/bkuhlmann/versionaire.svg?style=svg[Circle CI Status]
+
+Provides an immutable, thread-safe, and semantic version type when managing versions within your
+applications.
+
+toc::[]
+
+== Features
+
+* Provides https://semver.org[Semantic Versioning].
+* Provides immutable, thread-safe version instances.
+* Converts (casts) from a `String`, `Array`, `Hash`, or `Version` to a `Version`.
+
+== Screencasts
+
+[link=https://www.alchemists.io/screencasts/versionaire.html]
+image::https://www.alchemists.io/images/screencasts/versionaire/cover-original.png[Screencast,role=focal_point]
+
+== Requirements
+
+. https://www.ruby-lang.org[Ruby 2.7.x].
+
+== Setup
+
+=== Production
+
+To install, run:
+
+[source,bash]
+----
+gem install versionaire
+----
+
+Add the following to your Gemfile:
+
+[source,ruby]
+----
+gem "versionaire"
+----
+
+=== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/versionaire.git
+cd versionaire
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Usage
+
+=== Initialization
+
+A new version can be initialized in a variety of ways:
+
+[source,ruby]
+----
+Versionaire::Version.new                                    # "0.0.0"
+Versionaire::Version[major: 1]                              # "1.0.0"
+Versionaire::Version[major: 1, minor: 2]                    # "1.2.0"
+Versionaire::Version[major: 1, minor: 2, patch: 3]          # "1.2.3"
+----
+
+=== Equality
+
+==== Value (`+#==+`)
+
+Equality is deterimined by the state of the object. This means that a version is equal to another
+version as long as all of the values (i.e. state) are equal to each other. Example:
+
+[source,ruby]
+----
+version_a = Versionaire::Version[major: 1]
+version_b = Versionaire::Version[major: 2]
+version_c = Versionaire::Version[major: 1]
+
+version_a == version_a # true
+version_a == version_b # false
+version_a == version_c # true
+----
+
+Knowning this, versions can be compared against one another too:
+
+[source,ruby]
+----
+version_a > version_b                   # false
+version_a < version_b                   # true
+version_a.between? version_c, version_b # true
+----
+
+==== Hash (`#eql?`)
+
+Behaves exactly as `#==`.
+
+==== Case (`#===`)
+
+Behaves exactly as `#==`.
+
+==== Identity (`#equal?`)
+
+Works like any other standard Ruby object where an object is equal only to itself.
+
+[source,ruby]
+----
+version_a = Versionaire::Version[major: 1]
+version_b = Versionaire::Version[major: 2]
+version_c = Versionaire::Version[major: 1]
+
+version_a.equal? version_a # true
+version_a.equal? version_b # false
+version_a.equal? version_c # false
+----
+
+=== Conversions
+
+==== Function (Casting)
+
+The `Versionaire::Version` function is provided for explicit casting to a version:
+
+[source,ruby]
+----
+version = Versionaire::Version[major: 1]
+
+Versionaire::Version "1.0.0"
+Versionaire::Version [1, 0, 0]
+Versionaire::Version major: 1, minor: 0, patch: 0
+Versionaire::Version version
+----
+
+Each of these conversions will result in a version object that represents "`1.0.0`". When attempting
+to convert an unsupported type, a `+Versionaire::Errors::Conversion+` exception will be thrown.
+
+==== Implicit
+
+Implicit conversion to a `+String+` is supported:
+
+[source,ruby]
+----
+"1.0.0".match Versionaire::Version[major: 1] # <MatchData "1.0.0">
+----
+
+==== Explicit
+
+Explicit conversion to a `String`, `Array`, or `Hash` is supported:
+
+[source,ruby]
+----
+version = Versionaire::Version.new
+
+version.to_s # "0.0.0"
+version.to_a # [0, 0, 0]
+version.to_h # {major: 0, minor: 0, patch: 0}
+----
+
+=== Comparisons
+
+All versions are comparable which means any of the operators from the `+Comparable+` module will
+work. Example:
+
+[source,ruby]
+----
+version_1 = Versionaire::Version "1.0.0"
+version_2 = Versionaire::Version "2.0.0"
+
+version_1 < version_2 # true
+version_1 <= version_2 # true
+version_1 == version_2 # false (see Equality section above for details)
+version_1 > version_2 # false
+version_1 >= version_2 # false
+version_1.between? version_1, version_2 # true
+version_1.clamp version_1, version_2 # version_1 (added in Ruby 2.4.0)
+----
+
+=== Math
+
+Versions can be added and subtracted from each other.
+
+==== Addition
+
+[source,ruby]
+----
+version_1 = Versionaire::Version[major: 1, minor: 2, patch: 3]
+version_2 = Versionaire::Version[major: 2, minor: 5, patch: 7]
+version_1 + version_2 # "3.7.10"
+----
+
+==== Subtraction
+
+[source,ruby]
+----
+version_1 = Versionaire::Version[major: 1, minor: 2, patch: 3]
+version_2 = Versionaire::Version[major: 1, minor: 1, patch: 1]
+version_1 - version_2 # "0.1.2"
+
+version_1 = Versionaire::Version[major: 1]
+version_2 = Versionaire::Version[major: 5]
+version_1 - version_2 # Fails with a Versionaire::Errors::NegativeNumber
+----
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bundle exec rake
+----
+
+== Versioning
+
+Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means:
+
+* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
+== Code of Conduct
+
+Please note that this project is released with a link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
+participating in this project you agree to abide by its terms.
+
+== Contributions
+
+Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
+
+== License
+
+Read link:LICENSE.adoc[LICENSE] for details.
+
+== History
+
+Read link:CHANGES.adoc[CHANGES] for details.
+
+== Credits
+
+Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann.html[Brooke Kuhlmann].

data/lib/versionaire/identity.rb

@@ -3,20 +3,9 @@
 module Versionaire
   # Gem identity information.
   module Identity
-    def self.name
-      "versionaire"
-    end
-
-    def self.label
-      "Versionaire"
-    end
-
-    def self.version
-      "8.0.1"
-    end
-
-    def self.version_label
-      "#{label} #{version}"
-    end
+    NAME = "versionaire"
+    LABEL = "Versionaire"
+    VERSION = "8.1.0"
+    VERSION_LABEL = "#{LABEL} #{VERSION}"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versionaire
 version: !ruby/object:Gem::Version
-  version: 8.0.1
+  version: 8.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIC/jCCAeagAwIBAgIBAjANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
-  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0xOTAyMTcxNjAxMTFaFw0yMDAyMTcx
-  NjAxMTFaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
+  MIIC/jCCAeagAwIBAgIBAzANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
+  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMDAzMTUxNDQ1MzJaFw0yMTAzMTUx
+  NDQ1MzJaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
   IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
   xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
   brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
@@ -20,15 +20,15 @@ cert_chain:
   D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
   3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
   AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
-  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBANgfX7kPZkJvsbdWMvbe
-  DUUYxRTqTUzCDpLd2p3sQvgLMKjTNSKt6CFq/kh+98b6RCgO6DqiVfxvOEq02dvf
-  ebMN/ylQqan2FgiAs1rpP0/D4C0MlBjoDktsT+2IyLol1KmkDB20ExJ4Sf1GRNdA
-  hpWOtcgqHtmrc7xzgB6BuyoYufrKKUlCO3ewTM4C375D2qO7hIdKuMOO3CdPMtSk
-  OrWpbzCL+nbbXqeoqiHgZaUvcyyQrGj5sQRxMTzuMXzzQxtHnuTuKrcz16HMTX/O
-  dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
-  y84=
+  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAIHhAlD3po4sTYqacXaQ
+  XI9jIhrfMy//2PgbHWcETtlJPBeNUbbSNBABcllUHKqYsVDlSvSmss034KSWNR8F
+  bF1GcloicyvcCC4y6IoW4it0COAcdeaaxkxiBSgKdQFpff9REnDlIKK4uQ9lLxIo
+  Y2G5xubiziKZkyfWFuSr67PIjW3Bu673D1JVBArhA1qbgQmYQcy1CkGOjo+iO8Nf
+  7u/QSfBHb+r/bXhKscDgPpnKwbUmvgO2+94zJG9KsrmIydlzYfsD09aXKx0t6Xy4
+  2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
+  QWc=
   -----END CERTIFICATE-----
-date: 2020-02-01 00:00:00.000000000 Z
+date: 2020-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -232,11 +232,11 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
-- LICENSE.md
+- README.adoc
+- LICENSE.adoc
 files:
-- LICENSE.md
-- README.md
+- LICENSE.adoc
+- README.adoc
 - lib/versionaire.rb
 - lib/versionaire/conversion.rb
 - lib/versionaire/errors/base.rb
@@ -246,13 +246,14 @@ files:
 - lib/versionaire/filler.rb
 - lib/versionaire/identity.rb
 - lib/versionaire/version.rb
-homepage: https://github.com/bkuhlmann/versionaire
+homepage: https://www.alchemists.io/projects/versionaire
 licenses:
 - Apache-2.0
 metadata:
-  source_code_uri: https://github.com/bkuhlmann/versionaire
-  changelog_uri: https://github.com/bkuhlmann/versionaire/blob/master/CHANGES.md
   bug_tracker_uri: https://github.com/bkuhlmann/versionaire/issues
+  changelog_uri: https://www.alchemists.io/projects/versionaire/changes.html
+  documentation_uri: https://www.alchemists.io/projects/versionaire
+  source_code_uri: https://github.com/bkuhlmann/versionaire
 post_install_message: 
 rdoc_options: []
 require_paths:

data/README.md

@@ -1,228 +0,0 @@
-<p align="center">
-  <img src="versionaire.png" alt="Versionaire Icon"/>
-</p>
-
-# Versionaire
-
-[![Gem Version](https://badge.fury.io/rb/versionaire.svg)](http://badge.fury.io/rb/versionaire)
-[![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/e61fa9230ecc0bfa6f07/maintainability)](https://codeclimate.com/github/bkuhlmann/versionaire/maintainability)
-[![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/e61fa9230ecc0bfa6f07/test_coverage)](https://codeclimate.com/github/bkuhlmann/versionaire/test_coverage)
-[![Circle CI Status](https://circleci.com/gh/bkuhlmann/versionaire.svg?style=svg)](https://circleci.com/gh/bkuhlmann/versionaire)
-
-Provides an immutable, thread-safe, and semantic version type when managing versions within your
-applications.
-
-<!-- Tocer[start]: Auto-generated, don't remove. -->
-
-## Table of Contents
-
-  - [Features](#features)
-  - [Screencasts](#screencasts)
-  - [Requirements](#requirements)
-  - [Setup](#setup)
-  - [Usage](#usage)
-    - [Initialization](#initialization)
-    - [Equality](#equality)
-      - [Value (`#==`)](#value-)
-      - [Hash (`#eql?`)](#hash-eql)
-      - [Case (`#===`)](#case-)
-      - [Identity (`#equal?`)](#identity-equal)
-    - [Conversions](#conversions)
-      - [Function (Casting)](#function-casting)
-      - [Implicit](#implicit)
-      - [Explicit](#explicit)
-    - [Comparisons](#comparisons)
-    - [Math](#math)
-      - [Addition](#addition)
-      - [Subtraction](#subtraction)
-  - [Tests](#tests)
-  - [Versioning](#versioning)
-  - [Code of Conduct](#code-of-conduct)
-  - [Contributions](#contributions)
-  - [License](#license)
-  - [History](#history)
-  - [Credits](#credits)
-
-<!-- Tocer[finish]: Auto-generated, don't remove. -->
-
-## Features
-
-- Provides [Semantic Versioning](https://semver.org).
-- Provides immutable, thread-safe version instances.
-- Converts (casts) from a `String`, `Array`, `Hash`, or `Version` to a `Version`.
-
-## Screencasts
-
-[![asciicast](https://asciinema.org/a/291457.svg)](https://asciinema.org/a/291457)
-
-## Requirements
-
-1. [Ruby 2.7.x](https://www.ruby-lang.org).
-
-## Setup
-
-Type the following to install:
-
-    gem install versionaire
-
-Add the following to your Gemfile:
-
-    gem "versionaire"
-
-## Usage
-
-### Initialization
-
-A new version can be initialized in a variety of ways:
-
-    Versionaire::Version.new                                    # "0.0.0"
-    Versionaire::Version[major: 1]                              # "1.0.0"
-    Versionaire::Version[major: 1, minor: 2]                    # "1.2.0"
-    Versionaire::Version[major: 1, minor: 2, patch: 3]          # "1.2.3"
-
-### Equality
-
-#### Value (`#==`)
-
-Equality is deterimined by the state of the object. This means that a version is equal to another
-version as long as all of the values (i.e. state) are equal to each other. Example:
-
-    version_a = Versionaire::Version[major: 1]
-    version_b = Versionaire::Version[major: 2]
-    version_c = Versionaire::Version[major: 1]
-
-    version_a == version_a # true
-    version_a == version_b # false
-    version_a == version_c # true
-
-Knowning this, versions can be compared against one another too:
-
-    version_a > version_b                   # false
-    version_a < version_b                   # true
-    version_a.between? version_c, version_b # true
-
-#### Hash (`#eql?`)
-
-Behaves exactly as `#==`.
-
-#### Case (`#===`)
-
-Behaves exactly as `#==`.
-
-#### Identity (`#equal?`)
-
-Works like any other standard Ruby object where an object is equal only to itself.
-
-    version_a = Versionaire::Version[major: 1]
-    version_b = Versionaire::Version[major: 2]
-    version_c = Versionaire::Version[major: 1]
-
-    version_a.equal? version_a # true
-    version_a.equal? version_b # false
-    version_a.equal? version_c # false
-
-### Conversions
-
-#### Function (Casting)
-
-The `Versionaire::Version` function is provided for explicit casting to a version:
-
-    version = Versionaire::Version[major: 1]
-
-    Versionaire::Version "1.0.0"
-    Versionaire::Version [1, 0, 0]
-    Versionaire::Version major: 1, minor: 0, patch: 0
-    Versionaire::Version version
-
-Each of these conversions will result in a version object that represents "1.0.0". When attempting
-to convert an unsupported type, a `Versionaire::Errors::Conversion` exception will be thrown.
-
-#### Implicit
-
-Implicit conversion to a `String` is supported:
-
-    "1.0.0".match Versionaire::Version[major: 1] # <MatchData "1.0.0">
-
-#### Explicit
-
-Explicit conversion to a `String`, `Array`, or `Hash` is supported:
-
-    version = Versionaire::Version.new
-
-    version.to_s # "0.0.0"
-    version.to_a # [0, 0, 0]
-    version.to_h # {major: 0, minor: 0, patch: 0}
-
-### Comparisons
-
-All versions are comparable which means any of the operators from the `Comparable` module will work.
-Example:
-
-    version_1 = Versionaire::Version "1.0.0"
-    version_2 = Versionaire::Version "2.0.0"
-
-    version_1 < version_2 # true
-    version_1 <= version_2 # true
-    version_1 == version_2 # false (see Equality section above for details)
-    version_1 > version_2 # false
-    version_1 >= version_2 # false
-    version_1.between? version_1, version_2 # true
-    version_1.clamp version_1, version_2 # version_1 (added in Ruby 2.4.0)
-
-### Math
-
-Versions can be added and subtracted from each other.
-
-#### Addition
-
-    version_1 = Versionaire::Version[major: 1, minor: 2, patch: 3]
-    version_2 = Versionaire::Version[major: 2, minor: 5, patch: 7]
-    version_1 + version_2 # "3.7.10"
-
-#### Subtraction
-
-    version_1 = Versionaire::Version[major: 1, minor: 2, patch: 3]
-    version_2 = Versionaire::Version[major: 1, minor: 1, patch: 1]
-    version_1 - version_2 # "0.1.2"
-
-    version_1 = Versionaire::Version[major: 1]
-    version_2 = Versionaire::Version[major: 5]
-    version_1 - version_2 # Fails with a Versionaire::Errors::NegativeNumber
-
-## Tests
-
-To test, run:
-
-    bundle exec rake
-
-## Versioning
-
-Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
-
-- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
-- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
-- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
-
-## Code of Conduct
-
-Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
-participating in this project you agree to abide by its terms.
-
-## Contributions
-
-Read [CONTRIBUTING](CONTRIBUTING.md) for details.
-
-## License
-
-Copyright 2016 [Alchemists](https://www.alchemists.io).
-Read [LICENSE](LICENSE.md) for details.
-
-## History
-
-Read [CHANGES](CHANGES.md) for details.
-Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
-
-## Credits
-
-Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
-[Alchemists](https://www.alchemists.io).