README.md in versionaire-1.2.0 vs README.md in versionaire-2.0.0
- old
+ new
@@ -51,21 +51,22 @@
[](https://asciinema.org/a/40455)
# Requirements
-0. [MRI 2.3.0](https://www.ruby-lang.org)
+0. [Ruby 2.3.0](https://www.ruby-lang.org)
# Setup
For a secure install, type the following (recommended):
gem cert --add <(curl --location --silent https://www.alchemists.io/gem-public.pem)
gem install versionaire --trust-policy MediumSecurity
-NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
-allowing the installation of unsigned dependencies since they are beyond the scope of this gem.
+NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification
+while allowing the installation of unsigned dependencies since they are beyond the scope of this
+gem.
For an insecure install, type the following (not recommended):
gem install versionaire
@@ -86,12 +87,12 @@
## 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:
+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.new major: 1
version_b = Versionaire::Version.new major: 2
version_c = Versionaire::Version.new major: 1
@@ -136,12 +137,12 @@
Versionaire::Version "1.0.0"
Versionaire::Version [1, 0, 0]
Versionaire::Version major: 1, minor: 0, maintenance: 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.
+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:
@@ -185,31 +186,32 @@
# Versioning
Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
-- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
-- Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
+- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
# 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.
+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 (c) 2016 [Alchemists](https://www.alchemists.io).
-Read the [LICENSE](LICENSE.md) for details.
+Read [LICENSE](LICENSE.md) for details.
# History
-Read the [CHANGELOG](CHANGELOG.md) for details.
+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).
+Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
+[Alchemists](https://www.alchemists.io).